de.aristaflow.adept2.model.common

Interface IconDescriptor

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

All Known Subinterfaces:

ChangeableIconDescriptor

public interface IconDescriptor
extends UserAttributeContainer, PluginDataContainer

An icon descriptor is used as a reference to the icon in the repository and to store additional data, like a revision and support types.

Additional information may be required, depending on the context in which the icon descriptor is used. This information can be stored in the user attributes.

Author:

Ulrich Kreher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IconDescriptor.Dimension Simple class for a dimension, that is a width and a height in pixel used for icons.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns a description text of the icon (may be null).
IconDescriptor.Dimension[]	getDimensions() Gets all dimensions (width and height) the corresponding icon is available for.
java.util.UUID	getID() Returns the repository-wide unique ID of the icon.
java.lang.String	getName() The arbitrary name of the icon.
long	getRevision() Gets the (base) revision of this icon which allows to track changes.
State	getState() Gets the current deployment state of this code descriptor, that is whether it is currently modified, it can be used or it may not be used any more.

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Method Detail

getID

java.util.UUID getID()

Returns the repository-wide unique ID of the icon. It is used to reference the icon and allows for changing its name w/o needing to update any reference.

Returns:

The unique ID of the icon.

getName

java.lang.String getName()

The arbitrary name of the icon.

Returns:

The arbitrary name of the icon.

getDescription

java.lang.String getDescription()

Returns a description text of the icon (may be null).

Returns:

The description of the icon or null.

getDimensions

IconDescriptor.Dimension[] getDimensions()

Gets all dimensions (width and height) the corresponding icon is available for. If a needed dimension is not available, the icon will be scaled appropriately. However, scaling may decrease the quality of the icon.

Returns:

All dimensions (width and height) the corresponding icon is available for.

getRevision

long getRevision()

Gets the (base) revision of this icon which allows to track changes. To modify an icon (descriptor) it needs to be in a development branch. As soon as it is changed, its state is set to IN_DEVELOPMENT but the revision remains until the branch is released.

Returns:

The revision of this icon (descriptor) or the revision which it is based upon.

getState

State getState()

Gets the current deployment state of this code descriptor, that is whether it is currently modified, it can be used or it may not be used any more.

Returns:

The current deployment state of this code descriptor that implicitly also applies to all child entities.