NotationName (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.application.api
Interface NotationName

All Known Implementing Classes:: NotationNameImpl

public interface NotationName

Encapsulates specific attributes about a notation.

Since:: ARGO0.9.4

Method Summary

boolean equals(NotationName notationName)
          Ease-of-use helper to determine if this notation is the same as another.

java.lang.String getConfigurationValue()
          Returns the text string stored in the configuration for this notation.

javax.swing.Icon getIcon()
          Returns an icon for the notation, or null if no icon is available.

java.lang.String getName()
          Returns the name of the language.

java.lang.String getTitle()
          Returns a textual title for the notation.

java.lang.String getVersion()
          Returns the version of the language if applicable, otherwise null

java.lang.String toString()
          Ease-of-use helper for usage in swing.

Method Summary
`boolean`	`equals(NotationName notationName)` Ease-of-use helper to determine if this notation is the same as another.
`java.lang.String`	`getConfigurationValue()` Returns the text string stored in the configuration for this notation.
`javax.swing.Icon`	`getIcon()` Returns an icon for the notation, or null if no icon is available.
`java.lang.String`	`getName()` Returns the name of the language.
`java.lang.String`	`getTitle()` Returns a textual title for the notation.
`java.lang.String`	`getVersion()` Returns the version of the language if applicable, otherwise null
`java.lang.String`	`toString()` Ease-of-use helper for usage in swing.

Method Detail

getName

public java.lang.String getName()

Returns the name of the language.

Returns:: the language name.

getVersion

public java.lang.String getVersion()

Returns the version of the language if applicable, otherwise null

Returns:: the language version or null

getTitle

public java.lang.String getTitle()

Returns a textual title for the notation.

Returns:: a title for the language.

getIcon

public 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 if not available.

getConfigurationValue

public java.lang.String getConfigurationValue()

Returns the text string stored in the configuration for this notation. This string is used to determine notation equality in equals(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

public 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.

equals

public boolean equals(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())