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
 String getConfigurationValue()
          Returns the text string stored in the configuration for this notation.
 Icon getIcon()
          Returns an icon for the notation, or null if no icon is available.
 String getName()
          Returns the name of the language.
 String getTitle()
          Returns a textual title for the notation.
 String getVersion()
          Returns the version of the language if applicable, otherwise null.
 boolean sameNotationAs(NotationName notationName)
          Ease-of-use helper to determine if this notation is the same as another.
 String toString()
          Ease-of-use helper for usage in swing.
 

Method Detail

getName

public String getName()
Returns the name of the language.

Returns:
the language name.

getVersion

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

Returns:
The language version or null.

getTitle

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

Returns:
a title for the language.

getIcon

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

Returns:
An Icon for the language or null.

getConfigurationValue

public 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

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

Returns:
a String representation of the notation name.

sameNotationAs

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


ArgoUML © 1996-2004 (20050222)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook