AssociationEndNameNotationUml (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.notation.providers.uml
Class AssociationEndNameNotationUml

java.lang.Object
  org.argouml.notation.NotationProvider
      org.argouml.notation.providers.AssociationEndNameNotation
          org.argouml.notation.providers.uml.AssociationEndNameNotationUml

public class AssociationEndNameNotationUml
extends AssociationEndNameNotation
extends AssociationEndNameNotation

The UML notation for an association-end name (i.e. the role).

This notation supports the association end name, visibility, and stereotypes.

There is no support for the interface specifier (that maps to the "specification" of an AssociationEnd).

TODO: This is the only notation (that I'm aware of) that requires state. All others should become effectively singletons. - Bob.

Constructor Summary
`protected`	`AssociationEndNameNotationUml()` The constructor.

Method Summary
`static AssociationEndNameNotationUml`	`getInstance()` Create a new instance of AssociationEndNameNotationUml
`java.lang.String`	`getParsingHelp()`
`void`	`parse(java.lang.Object modelElement, java.lang.String text)` Parses the given text, and adapts the modelElement and maybe related elements accordingly.
`protected void`	`parseAssociationEnd(java.lang.Object role, java.lang.String text)`
`java.lang.String`	`toString(java.lang.Object modelElement, NotationSettings settings)` Generate a string representation for the given model element.

Methods inherited from class org.argouml.notation.providers.AssociationEndNameNotation
`initialiseListener, updateListener`

Methods inherited from class org.argouml.notation.NotationProvider
`addElementListener, addElementListener, addElementListener, cleanListener, formatNameList, formatNameList, removeAllElementListeners, removeElementListener`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AssociationEndNameNotationUml

protected AssociationEndNameNotationUml()

The constructor.

Method Detail

getInstance

public static final AssociationEndNameNotationUml getInstance()

Create a new instance of AssociationEndNameNotationUml

Returns:: the notation

getParsingHelp

public java.lang.String getParsingHelp()

Specified by:: getParsingHelp in class NotationProvider

Returns:: a i18 key that represents a help string giving an explanation to the user of the syntax

parse

public void parse(java.lang.Object modelElement,
                  java.lang.String text)

Description copied from class: NotationProvider

Parses the given text, and adapts the modelElement and maybe related elements accordingly.

Specified by:: parse in class NotationProvider

Parameters:: modelElement - the modelelement to adapt; text - the string given by the user to be parsed to adapt the model

parseAssociationEnd

protected void parseAssociationEnd(java.lang.Object role,
                                   java.lang.String text)
                            throws java.text.ParseException

Parameters:: role - The AssociationEnd text describes.; text - A String on the above format.
Throws:: java.text.ParseException - when it detects an error in the role string. See also ParseError.getErrorOffset().

toString

public java.lang.String toString(java.lang.Object modelElement,
                                 NotationSettings settings)

Description copied from class: NotationProvider

Generate a string representation for the given model element.

Specified by:: toString in class NotationProvider

Parameters:: modelElement - the base UML element; settings - settings that control rendering of the text
Returns:: the string written in the correct notation