us.temerity.pipeline
Class Named

java.lang.Object
  us.temerity.pipeline.Named

All Implemented Interfaces:

Serializable, Cloneable, Glueable

Direct Known Subclasses:

ActionInfo, ArchiveVolume, BaseExtensionConfig, Described, DispatchControl, ExternalInfo, HardwareGroup, HistogramSpec, LinkCommon, NodeCommon, NodeID, PackageCommon, PluginID, QueueHostInfo, SelectionGroup, SelectionSchedule, Toolset, UserBalanceGroup

public class Named
extends Object
implements Cloneable, Glueable, Serializable

Provides a simple name String and accessor.

See Also:

Serialized Form

Field Summary

protected String

pName The name of the instance.

Constructor Summary

protected	Named() This constructor is required by the GlueDecoder to instantiate the class when encountered during the reading of GLUE format files and should not be called from user code.
protected	Named(String name) Internal constructor used by subclasses to initialize the name.

Method Summary

Object	clone() Return a deep copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	fromGlue(GlueDecoder decoder) Restores the non-transient fields of the class from Glue.
String	getName() Gets the name of this instance.
void	toGlue(GlueEncoder encoder) Saves the non-transient fields of this object as Glue.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pName

protected String pName

The name of the instance.

Constructor Detail

Named

protected Named()

This constructor is required by the GlueDecoder to instantiate the class when encountered during the reading of GLUE format files and should not be called from user code.

Named

protected Named(String name)

Internal constructor used by subclasses to initialize the name.

Parameters:

name - The name of this instance.

Method Detail

getName

public String getName()

Gets the name of this instance.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - The reference object with which to compare.

clone

public Object clone()

Return a deep copy of this object.

Overrides:

clone in class Object

toGlue

public void toGlue(GlueEncoder encoder)
            throws GlueException

Description copied from interface: Glueable

Saves the non-transient fields of this object as Glue. Typically, the implementation will call GlueEncoder.encode for each non-transient field of the parent object.

Specified by:

toGlue in interface Glueable

Parameters:

encoder - [modified] The object used to encode this object's fields into Glue format.

Throws:

GlueException

fromGlue

public void fromGlue(GlueDecoder decoder)
              throws GlueException

Description copied from interface: Glueable

Restores the non-transient fields of the class from Glue. Typically, the implementation will call GlueDecoder.decode for each non-transient field of the parent object.

Specified by:

fromGlue in interface Glueable

Parameters:

decoder - The object used to decode this object's fields from Glue format.

Throws:

GlueException