Package de.xima.fc.mdl.plugin

Class PluginMeta

java.lang.Object

de.xima.fc.mdl.plugin.PluginMeta

All Implemented Interfaces:

Serializable

@Immutable
public final class PluginMeta
extends Object
implements Serializable

A target plugin that is to be updated. Contains the name of an updated plugin, with the plugin's ID and its name. Instances of this class are equated by getEntityId().

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginMeta(PluginID pluginId, String technicalName, String localizedName, long entityId)
PluginMeta(PluginID pluginId, String technicalName, String localizedName, WorkspaceScope scope, long entityId)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
long	getEntityId()	Get the ID of the plugin entity that stores the plugin.
String	getLocalizedName()
PluginID	getPluginId()
WorkspaceScope	getScope()
String	getTechnicalName()
int	hashCode()
boolean	isHasEntity()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginMeta

public PluginMeta(PluginID pluginId,
                  String technicalName,
                  String localizedName,
                  WorkspaceScope scope,
                  long entityId)

Creates a new POJO with the given data.

Parameters:

pluginId - The ID of the plugin.

technicalName - The technical name of the plugin, if known, or the plugin ID otherwise.

localizedName - The localized name of the plugin, if known.

scope - The scope of the plugin, if known.

entityId - ID of the corresponding plugin entity, if an existing plugin, or -1 otherwise.

PluginMeta

public PluginMeta(PluginID pluginId,
                  String technicalName,
                  String localizedName,
                  long entityId)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEntityId

public long getEntityId()

Get the ID of the plugin entity that stores the plugin. If not an existing plugin, returns -1.

Returns:

Database ID of the corresponding plugin entity.

getTechnicalName

public String getTechnicalName()

Returns:

The technical name of the plugin, if known, or getPluginId() otherwise.

getLocalizedName

public String getLocalizedName()

Returns:

The localized name of the plugin, if known, or same as getTechnicalName() otherwise.

getScope

public WorkspaceScope getScope()

Returns:

The scope of the plugin, if known.

getPluginId

public PluginID getPluginId()

Returns:

The ID of the plugin.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isHasEntity

public boolean isHasEntity()

Returns:

Whether a plugin entity exists.

toString

public String toString()

Overrides:

toString in class Object