ComponentInstanceNotationUml (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 ComponentInstanceNotationUml

java.lang.Object
  org.argouml.notation.NotationProvider
      org.argouml.notation.providers.ComponentInstanceNotation
          org.argouml.notation.providers.uml.ComponentInstanceNotationUml

public class ComponentInstanceNotationUml
extends ComponentInstanceNotation
extends ComponentInstanceNotation

UML notation for a component instance.

Constructor Summary
`ComponentInstanceNotationUml(java.lang.Object componentInstance)` The constructor.

Method Summary
`java.lang.String`	`getParsingHelp()`
`void`	`parse(java.lang.Object modelElement, java.lang.String text)` Parse a line of the form: "name : base-component".
`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.NotationProvider
`addElementListener, addElementListener, addElementListener, cleanListener, formatNameList, formatNameList, initialiseListener, removeAllElementListeners, removeElementListener, updateListener`

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

Constructor Detail

ComponentInstanceNotationUml

public ComponentInstanceNotationUml(java.lang.Object componentInstance)

The constructor.

Parameters:: componentInstance - the UML componentInstance

Method Detail

parse

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

Parse a line of the form: "name : base-component".

The base-component part is a comma separated list of Components.

Note that stereotypes are not supported. 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

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

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