de.uni_paderborn.fujaba.uml
Class UMLCommentary

java.lang.Object
  extended byde.uni_paderborn.fujaba.basic.BasicIncrement
      extended byde.uni_paderborn.fujaba.asg.ASGElement
          extended byde.uni_paderborn.fujaba.uml.UMLIncrement
              extended byde.uni_paderborn.fujaba.uml.UMLCommentary
All Implemented Interfaces:
java.lang.Comparable, FCommentary, FElement, FIncrement, de.uni_kassel.prop.InspectionAware, LogicUnparseInterface, de.tu_bs.coobra.ObjectChangeAware, de.upb.tools.pcs.PropertyChangeClient, de.upb.tools.pcs.PropertyChangeInterface, UniqueIdentifier

public class UMLCommentary
extends UMLIncrement
implements FCommentary

Provides commentary nodes for the diags.

Associations

                1                       1
 UMLCommentary --------------------------- UMLIncrement
                comment        revComment
 

Version:
$Revision: 1.53 $
Author:
$Author: cschneid $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
private  UMLIncrement revComment
           1 1 UMLCommentary --------------------------- UMLIncrement comment revComment
private  java.lang.String text
          UMLAttribute: '+ text : String'
 
Fields inherited from class de.uni_paderborn.fujaba.uml.UMLIncrement
 
Fields inherited from class de.uni_paderborn.fujaba.asg.ASGElement
 
Fields inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
dontUseAccessMethodsInThisClass
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FCommentary
REV_COMMENT_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
ASSERT_IN_UNIT_TEST_PROPERTY, COMMENT_PROPERTY, CONSTRAINTS_PROPERTY, STEREOTYPES_PROPERTY
 
Fields inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
ANNOTATIONS_PROPERTY, DIAGRAMS_PROPERTY, ELEMENT_REFERENCES_PROPERTY, GENERATED_PROPERTY, NAME_PROPERTY, TEXT_PROPERTY
 
Constructor Summary
UMLCommentary()
          Constructor for class UMLCommentary
UMLCommentary(boolean coobraPersistent)
          Constructor for class UMLCommentary
UMLCommentary(java.lang.String text)
          Constructor for class UMLCommentary
 
Method Summary
protected  java.lang.String createUnparseModuleName()
          No comment provided by developer, please add a comment to improve documentation.
 java.lang.String deleteBlancLines(java.lang.String text)
          No comment provided by developer, please add a comment to improve documentation.
 java.lang.String getCommentedText()
          Get the commentedText attribute of the UMLCommentary object
 FIncrement getFRevComment()
          Get the fRevComment attribute of the UMLCommentary object
 java.lang.String getIncrText()
          Get the incrText attribute of the UMLCommentary object
 FElement getParentElement()
          Query the logical parent of this element (e.g. package of a class, diagram of an object).
 UMLIncrement getRevComment()
          Get the revComment attribute of the UMLCommentary object
 java.lang.String getText()
          Get the text attribute of the UMLCommentary object
 boolean getVisibilityOfFirstIncr()
          Get the visibilityOfFirstIncr attribute of the UMLCommentary object
 void removeYou()
          No comment provided by developer, please add a comment to improve documentation.
 void setRevComment(FIncrement revComment)
          Sets the revComment attribute of the UMLCommentary object
 java.lang.String setText(java.lang.String text)
          Sets the text attribute of the UMLCommentary object
 void swapVisibilityTo(boolean value)
          No comment provided by developer, please add a comment to improve documentation.
 
Methods inherited from class de.uni_paderborn.fujaba.uml.UMLIncrement
addToConstraints, addToStereotypes, addToStereotypes, elementsOfAllChildren, entriesOfStereotypes, getComment, getFComment, getFromFStereotypes, getFromStereotypes, getFromStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, setStereotype, sizeOfConstraint, sizeOfStereotypes
 
Methods inherited from class de.uni_paderborn.fujaba.asg.ASGElement
acknowledgeChange, addAdditionalListener, addPointToUnparseInformation, addPropertyChangeListener, addPropertyChangeListener, addToAnnotations, addToDiagrams, addToElementReferences, addToElementReferences, addToFsaObjects, addToLocations, addToLocations, addToPropertyChangeListeners, addToPropertyChangeListeners, addToUnparseInformations, addToUnparseInformations, addToUserMessages, deleteTokens, elementsOfDiagrams, entriesOfElementReferences, entriesOfFsaObjects, entriesOfUnparseInformations, fireEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCoObRAId, getFirstFromFSAObjects, getFirstOOGenToken, getFromElementReferences, getFromFElementReferences, getFromFsaObjects, getFromUnparseInformations, getFSAInterface, getLastModified, getLastOOGenToken, getName, getPointFromUnparseInformation, getPropertyChangeSupport, getRepository, getTransientElements, getUnparseModuleName, getUnparseModuleNameImpl, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasInFsaObjects, hasKeyInElementReferences, hasKeyInFsaObjects, initPersistency, isCoobraPersistent, isInspectableField, isInTransientMode, isReadOnly, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfFsaObjects, iteratorOfKeyFromUnparseInformations, iteratorOfUnparseInformations, iteratorOfUserMessages, keysOfElementReferences, keysOfFsaObjects, keysOfUnparseInformations, proposeFieldValues, removeAdditionalListener, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromFsaObjects, removeAllFromUnparseInformations, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromFsaObjects, removeFromPropertyChangeListeners, removeFromPropertyChangeListeners, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUnparseInformations, removeFromUserMessages, removeKeyFromElementReferences, removeKeyFromFsaObjects, removePropertyChangeListener, removePropertyChangeListener, saveFSAProperties, saveLocations, searchID, setCoObRAId, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setInTransientMode, setLastOOGenToken, setName, setRepository, setUnparseModuleName, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfFsaObjects, sizeOfUserMessages, updateFSACollapsed, updateFSALocation, updateKeyInFsaObjects, writeAttributes
 
Methods inherited from class de.uni_paderborn.fujaba.basic.BasicIncrement
compareTo, getID, getUniqueID, getUniqueID, isGenerated, lessUniqueId, readAttributes, readAttributes, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, readFromStringTokenizer, resetClassInfos, resetFieldWriteMethods, setAttribValue, setAttribValue, setID, setUniqueId, writeClassToStringBuffer, writeClassToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer, writeToStringBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FIncrement
addToConstraints, addToStereotypes, entriesOfStereotypes, getFComment, getFromFStereotypes, hasInConstraints, hasInStereotypes, hasKeyInStereotypes, isAssertInUnitTest, iteratorOfConstraints, iteratorOfStereotypes, keysOfStereotypes, removeAllFromConstraints, removeAllFromStereotypes, removeFromConstraints, removeFromStereotypes, removeKeyFromStereotypes, setAssertInUnitTest, setComment, sizeOfStereotypes
 
Methods inherited from interface de.uni_paderborn.fujaba.metamodel.FElement
addToAnnotations, addToDiagrams, addToElementReferences, addToElementReferences, addToUserMessages, deleteTokens, entriesOfElementReferences, getFirstOOGenToken, getFromFElementReferences, getLastOOGenToken, getName, hasInAnnotations, hasInDiagrams, hasInElementReferences, hasInElementReferences, hasKeyInElementReferences, isCoobraPersistent, isGenerated, iteratorOfAnnotations, iteratorOfDiagrams, iteratorOfElementReferences, iteratorOfUserMessages, keysOfElementReferences, removeAllFromAnnotations, removeAllFromDiagrams, removeAllFromElementReferences, removeAllFromUserMessages, removeFromAnnotations, removeFromDiagrams, removeFromElementReferences, removeFromElementReferences, removeFromUserMessages, removeKeyFromElementReferences, setCutCopyPasteParent, setFirstOOGenToken, setGenerated, setLastOOGenToken, setName, sizeOfAnnotations, sizeOfDiagrams, sizeOfElementReferences, sizeOfUserMessages
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface de.uni_paderborn.fujaba.basic.UniqueIdentifier
getID
 
Methods inherited from interface de.uni_paderborn.fujaba.fsa.unparse.LogicUnparseInterface
getFSAInterface, getUnparseModuleName
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeInterface
getPropertyChangeSupport
 
Methods inherited from interface de.upb.tools.pcs.PropertyChangeClient
addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface de.tu_bs.coobra.ObjectChangeAware
acknowledgeChange, getCoObRAId, getRepository, setCoObRAId, setRepository
 
Methods inherited from interface de.uni_kassel.prop.InspectionAware
isInspectableField, proposeFieldValues
 

Field Detail

revComment

private transient UMLIncrement revComment
                1                       1
 UMLCommentary --------------------------- UMLIncrement
                comment        revComment
 


text

private java.lang.String text
UMLAttribute: '+ text : String'

Constructor Detail

UMLCommentary

public UMLCommentary()
Constructor for class UMLCommentary


UMLCommentary

public UMLCommentary(boolean coobraPersistent)
Constructor for class UMLCommentary

Parameters:
coobraPersistent - No description provided

UMLCommentary

public UMLCommentary(java.lang.String text)
Constructor for class UMLCommentary

Parameters:
text - No description provided
Method Detail

createUnparseModuleName

protected java.lang.String createUnparseModuleName()
No comment provided by developer, please add a comment to improve documentation.

Overrides:
createUnparseModuleName in class ASGElement
Returns:
No description provided

swapVisibilityTo

public void swapVisibilityTo(boolean value)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided

getVisibilityOfFirstIncr

public boolean getVisibilityOfFirstIncr()
Get the visibilityOfFirstIncr attribute of the UMLCommentary object

Returns:
The visibilityOfFirstIncr value

getRevComment

public UMLIncrement getRevComment()
Get the revComment attribute of the UMLCommentary object

Returns:
The revComment value

getFRevComment

public FIncrement getFRevComment()
Get the fRevComment attribute of the UMLCommentary object

Specified by:
getFRevComment in interface FCommentary
Returns:
The fRevComment value

setRevComment

public void setRevComment(FIncrement revComment)
Sets the revComment attribute of the UMLCommentary object

Specified by:
setRevComment in interface FCommentary
Parameters:
revComment - The new revComment value

deleteBlancLines

public java.lang.String deleteBlancLines(java.lang.String text)
No comment provided by developer, please add a comment to improve documentation.

Parameters:
text - No description provided
Returns:
No description provided

getIncrText

public java.lang.String getIncrText()
Get the incrText attribute of the UMLCommentary object

Returns:
The incrText value

getText

public java.lang.String getText()
Get the text attribute of the UMLCommentary object

Specified by:
getText in interface FElement
Overrides:
getText in class ASGElement
Returns:
The text value

getCommentedText

public java.lang.String getCommentedText()
Get the commentedText attribute of the UMLCommentary object

Returns:
The commentedText value

setText

public java.lang.String setText(java.lang.String text)
Sets the text attribute of the UMLCommentary object

Specified by:
setText in interface FCommentary
Parameters:
text - The new text value
Returns:
No description provided

removeYou

public void removeYou()
No comment provided by developer, please add a comment to improve documentation.

Specified by:
removeYou in interface FElement
Overrides:
removeYou in class UMLIncrement

getParentElement

public FElement getParentElement()
Query the logical parent of this element (e.g. package of a class, diagram of an object).

Specified by:
getParentElement in interface FElement
Overrides:
getParentElement in class ASGElement
Returns:
the logical parent of this element, may not return null unless this is the top level node (project)