org.argouml.notation
Interface NotationName

public interface NotationName

Encapsulates specific attributes about a notation.

Since:

ARGO0.9.4

getName

java.lang.String getName()

Returns the name of the language.

Returns:

the language name.

getVersion

java.lang.String getVersion()

Returns the version of the language if applicable, otherwise null.

Returns:

The language version or null.

getTitle

java.lang.String getTitle()

Returns a textual title for the notation. The name and version.

Returns:

a title for the language.

getIcon

javax.swing.Icon getIcon()

Returns an icon for the notation, or null if no icon is available.

Returns:

An Icon for the language or null.

getConfigurationValue

java.lang.String getConfigurationValue()

Returns the text string stored in the configuration for this notation. This string is used to determine notation equality in sameNotationAs(NotationName).

This should incorporate both the name and the version if one exists.

Returns:

the value for this notation to be stored in the configuration.

toString

java.lang.String toString()

Ease-of-use helper for usage in swing. Usually, it is equal to getConfigurationValue().

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the notation name.

sameNotationAs

boolean sameNotationAs(NotationName notationName)

Ease-of-use helper to determine if this notation is the same as another. This must be equivalent to getConfigurationValue().equals(nn.getConfigurationValue())

Parameters:

notationName - to compare

Returns:

boolean indicating equality or inequality.