public class Documentation extends StringAttribute
The name of a documentation object can often be meaningful. Many times the name can be used to specify important information about the type of documentation. Unfortunately, all documentation objects are currently treated the same.
| Yellow (neuendor) |
| Yellow (eal) |
NamedObj.ContainedObjectsIteratorSettable.Visibility_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKSEXPERT, FULL, NONE, NOT_EDITABLE| Constructor and Description |
|---|
Documentation(NamedObj container,
java.lang.String name)
Construct an attribute with the specified container and name.
|
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
consolidate(NamedObj object)
Return as a single string all the documentation associated with
the specified object.
|
void |
exportMoML(java.io.Writer output,
int depth,
java.lang.String name)
Write a MoML description of this object with the specified
indentation depth.
|
void |
setExpression(java.lang.String expression)
Override the base class to remove this instance from
its container if the argument is an empty string.
|
void |
setValue(java.lang.String value)
Set the documentation string.
|
java.lang.String |
toString()
Get the documentation as a string, with the class name prepended.
|
_propagateValue, addValueListener, clone, getExpression, getVisibility, removeValueListener, setVisibility, validategetDefaultExpression, getValueAsString_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetDisplayNamedescription, getContainer, getFullName, getName, getName, setNamepublic Documentation(NamedObj container, java.lang.String name) throws IllegalActionException, NameDuplicationException
container - The container.name - The name of the attribute.IllegalActionException - If the attribute is not of an
acceptable class for the container.NameDuplicationException - If the name coincides with
an attribute already in the container.public static java.lang.String consolidate(NamedObj object)
object - The object to document.public void exportMoML(java.io.Writer output,
int depth,
java.lang.String name)
throws java.io.IOException
exportMoML in interface MoMLExportableexportMoML in class StringAttributeoutput - The output stream to write to.depth - The depth in the hierarchy, to determine indenting.name - The name to use instead of the current name.java.io.IOException - If an I/O error occurs.NamedObj._exportMoMLContents(java.io.Writer, int),
NamedObj.isPersistent()public void setExpression(java.lang.String expression)
throws IllegalActionException
setExpression in interface SettablesetExpression in class StringAttributeexpression - The value of the string attribute.IllegalActionException - If the change is not acceptable
to the container.StringAttribute.getExpression()public void setValue(java.lang.String value)
value - The documentation.AbstractSettableAttribute.getValueAsString()