us.temerity.pipeline
Class PluginID

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

Direct Known Subclasses:

BasePlugin, BuilderID

public class PluginID
extends Named
implements Comparable<PluginID>

A unique combination of name, version and vendor used to identify a specific plugin.

See Also:

Serialized Form

Field Summary

protected String	pVendor The name of the plugin vendor.
protected VersionID	pVersionID The revision number of the plugin.

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

PluginID()
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.

PluginID(PluginID pluginID)
Copy constructor.

PluginID(String name, VersionID vid, String vendor)
Construct with the given name, version and vendor.

Method Summary

int	compareTo(PluginID pluginID) Compares this PluginID with the given PluginID for order.
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	getVendor() Get the name of the plugin vendor.
VersionID	getVersionID() Get the revision number of the plugin.
void	toGlue(GlueEncoder encoder) Saves the non-transient fields of this object as Glue.
String	toString() Returns a string representation of the object.

Methods inherited from class us.temerity.pipeline.Named

clone, getName

Methods inherited from class java.lang.Object

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

Field Detail

pVersionID

protected VersionID pVersionID

The revision number of the plugin.

pVendor

protected String pVendor

The name of the plugin vendor.

Constructor Detail

PluginID

public PluginID()

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.

PluginID

public PluginID(String name,
                VersionID vid,
                String vendor)

Construct with the given name, version and vendor.

Parameters:

name - The short name of the plugin

vid - The plugin revision number.

vendor - The name of the plugin vendor.

PluginID

public PluginID(PluginID pluginID)

Copy constructor.

Parameters:

pluginID - The plugin ID to copy.

Method Detail

getVersionID

public final VersionID getVersionID()

Get the revision number of the plugin.

getVendor

public final String getVendor()

Get the name of the plugin vendor.

equals

public boolean equals(Object obj)

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

Overrides:

equals in class Named

Parameters:

obj - The reference object with which to compare.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

compareTo

public int compareTo(PluginID pluginID)

Compares this PluginID with the given PluginID for order.

Specified by:

compareTo in interface Comparable<PluginID>

Parameters:

pluginID - The PluginID to be compared.

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

Overrides:

toGlue in class Named

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

Overrides:

fromGlue in class Named

Parameters:

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

Throws:

GlueException