Package ptolemy.kernel.util.test

Class InvalidStringAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.AbstractSettableAttribute

ptolemy.kernel.util.StringAttribute

ptolemy.kernel.util.test.InvalidStringAttribute

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Settable

public class InvalidStringAttribute
extends StringAttribute

An attribute used for testing that is never valid.

Since:

Ptolemy II 5.2

Version:

$Id$

Author:

Christopher Brooks

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Nested classes/interfaces inherited from interface ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Constructor Summary

Constructors

Constructor	Description
InvalidStringAttribute()	Construct an attribute in the default workspace with an empty string as its name.
InvalidStringAttribute(NamedObj container, java.lang.String name)	Construct an attribute with the given name contained by the specified entity.
InvalidStringAttribute(Workspace workspace)	Construct an attribute in the specified workspace with an empty string as a name.

Method Summary

Modifier and Type	Method	Description
java.util.Collection	validate()	Throw either a KernelRuntimeException or an IllegalActionException.

Methods inherited from class ptolemy.kernel.util.StringAttribute

_propagateValue, addValueListener, clone, exportMoML, getExpression, getVisibility, removeValueListener, setExpression, setVisibility

Methods inherited from class ptolemy.kernel.util.AbstractSettableAttribute

getDefaultExpression, getValueAsString

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_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, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Settable

getDisplayName

Constructor Detail

InvalidStringAttribute

public InvalidStringAttribute()

Construct an attribute in the default workspace with an empty string as its name. The object is added to the directory of the workspace. Increment the version number of the workspace.

InvalidStringAttribute

public InvalidStringAttribute(Workspace workspace)

Construct an attribute in the specified workspace with an empty string as a name. You can then change the name with setName(). If the workspace argument is null, then use the default workspace. The object is added to the directory of the workspace. Increment the version number of the workspace.

Parameters:

workspace - The workspace that will list the attribute.

InvalidStringAttribute

public InvalidStringAttribute(NamedObj container,
                              java.lang.String name)
                       throws IllegalActionException,
                              NameDuplicationException

Construct an attribute with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this attribute.

Throws:

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

NameDuplicationException - If the name coincides with an attribute already in the container.

Method Detail

validate

public java.util.Collection validate()
                              throws IllegalActionException

Throw either a KernelRuntimeException or an IllegalActionException.

Specified by:

validate in interface Settable

Overrides:

validate in class StringAttribute

Returns:

Null, indicating that no other instances of Settable are validated.

Throws:

IllegalActionException - If the expression is not valid, or its value is not acceptable to the container or the listeners.