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.2.1 $
Author:
$Author: fklar $

Nested Class Summary
 
Nested classes inherited from class de.uni_paderborn.fujaba.asg.ASGElement
ASGElement.SortByNameComparator
 
Field Summary
 
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)
          Deprecated. If no one insists on using this method (e.g. plugin-developers), it may be deleted, otherwise remove this deprecated-flag.
static java.lang.String deleteInitialBlancs(java.lang.String text, boolean removeAsterisk)
          Deletes leading blancs, from each line of the text and if specified preceeding asterisks as well.
 java.lang.String getCommentedText()
          Get the text of this UMLCommentary in a Java-like multi-line-comment or single-line representation.
 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
static java.lang.String getUncommentedText(java.lang.String text)
          Use this method to get an uncommented version of Java-style-commented text.
 boolean getVisibilityOfFirstIncr()
          Deprecated. Use UMLCommentary#isVisible() instead.
 boolean isVisible()
          Get visibility-state of this commentary in the current diagram.
 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 setVisible(boolean value)
          Set visibility-state of this commentary in the current diagram.
 void swapVisibilityTo(boolean value)
          Deprecated. Use UMLCommentary#setVisible(boolean) instead.
 
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, initElementListener, initPersistency, isCoobraPersistent, isInspectableField, isInTransientMode, isPersistencyChange, 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
 

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)
Deprecated. Use UMLCommentary#setVisible(boolean) instead.

No comment provided by developer, please add a comment to improve documentation.

Parameters:
value - No description provided

getVisibilityOfFirstIncr

public boolean getVisibilityOfFirstIncr()
Deprecated. Use UMLCommentary#isVisible() instead.

Get the visibilityOfFirstIncr attribute of the UMLCommentary object

Returns:
The visibilityOfFirstIncr value

isVisible

public boolean isVisible()
Get visibility-state of this commentary in the current diagram. If no diagram is currently active, false is returned.

Returns:
The current visibility-state of this commentary.

setVisible

public void setVisible(boolean value)
Set visibility-state of this commentary in the current diagram. Nothing will happen, if no diagram is currently active. Note to refresh the display after calling this method.

Parameters:
value - The new visibility-state of this commentary.

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)
Deprecated. If no one insists on using this method (e.g. plugin-developers), it may be deleted, otherwise remove this deprecated-flag.

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

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
See Also:
getUncommentedText(String)

getCommentedText

public java.lang.String getCommentedText()
Get the text of this UMLCommentary in a Java-like multi-line-comment or single-line representation.

Returns:
The commented text.

getUncommentedText

public static java.lang.String getUncommentedText(java.lang.String text)
Use this method to get an uncommented version of Java-style-commented text.
 Use this function, e.g. if you want to adjust the text of a UMLCommentary
 but only have commented text, or don't know if the text you have
 contains comment-symbols and you want them to be removed.

 Example code:
   String uncommentedText = UMLCommentary.getUncommentedText(myCommentedText);
   UMLCommentary theCommentary = ...;
   theCommentary.setText(uncommentedText);
 

Parameters:
text - A String containing commented Java-style text.
Returns:
A String without comment-symbols.

deleteInitialBlancs

public static java.lang.String deleteInitialBlancs(java.lang.String text,
                                                   boolean removeAsterisk)
Deletes leading blancs, from each line of the text and if specified preceeding asterisks as well.

Parameters:
text - A String.
removeAsterisk - Should preceeding asteriks be removed as well?
Returns:
The String without leading blancs.

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)