public interface Nameable
| Green (johnr) |
| Green (eal) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
description()
Return a description of the object.
|
NamedObj |
getContainer()
Return the container.
|
java.lang.String |
getDisplayName()
Return a name to present to the user.
|
java.lang.String |
getFullName()
Return the full name, which reflects the container object, if there
is one.
|
java.lang.String |
getName()
Return the name of the object.
|
java.lang.String |
getName(NamedObj relativeTo)
Get the name of this object relative to the specified container.
|
void |
setName(java.lang.String name)
Set or change the name.
|
java.lang.String description()
throws IllegalActionException
IllegalActionException - If there is a problem accessing
subcomponents of the object.NamedObj getContainer()
java.lang.String getDisplayName()
java.lang.String getFullName()
java.lang.String getName()
setName(String)java.lang.String getName(NamedObj relativeTo) throws InvalidStateException
relativeTo - The object relative to which you want the name.InvalidStateException - If a recursive structure is
encountered, where this object directly or indirectly contains
itself. Note that this is a runtime exception so it need not
be declared explicitly.setName(String)void setName(java.lang.String name)
throws IllegalActionException,
NameDuplicationException
name - The new name.IllegalActionException - If the name contains a period.NameDuplicationException - If the container already
contains an object with this name.getName(),
getName(NamedObj)