Openwings API Documentation (v1.1)

net.openwings.context
Class PlatformDescriptor

java.lang.Object
  extended bynet.openwings.context.PlatformDescriptor
All Implemented Interfaces:
java.io.Serializable

public class PlatformDescriptor
extends java.lang.Object
implements java.io.Serializable

This class defines the information that makes up a platform descriptor.

See Also:
Serialized Form

Constructor Summary
PlatformDescriptor()
          Default constructor.
PlatformDescriptor(UniqueID platform, java.lang.String name, boolean clustered)
          This constructor sets the value of the platform desciptor.
 
Method Summary
 boolean equals(java.lang.Object other)
          overrides default equals() method.
 boolean getClustered()
          This method is used to find out if the platform is part of the context cluster.
 java.lang.String getName()
          This method returns the name of the platform.
 UniqueID getPlatform()
          This method returns the unique id of the platform.
 int hashCode()
          overrides default hashCode() method.
 void setClustered(boolean clustered)
          This method sets whether the platform is part of the context cluster.
 void setName(java.lang.String name)
          This method sets the name of the platform.
 void setPlatform(UniqueID platformID)
          This method sets the unique id of the platform.
 java.lang.String toString()
          overrides default toString() method.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PlatformDescriptor

public PlatformDescriptor()
Default constructor.


PlatformDescriptor

public PlatformDescriptor(UniqueID platform,
                          java.lang.String name,
                          boolean clustered)
This constructor sets the value of the platform desciptor.

Parameters:
platform - Id of the platform added.
name - Host name of the platform being added.
clustered - Returns true if the platform was part of the container manager cluster.
Method Detail

getPlatform

public UniqueID getPlatform()
This method returns the unique id of the platform.

Returns:
platform Id of the platform

setPlatform

public void setPlatform(UniqueID platformID)
This method sets the unique id of the platform.

Parameters:
platformID - unique Id of the platform

getName

public java.lang.String getName()
This method returns the name of the platform.

Returns:
platform name

setName

public void setName(java.lang.String name)
This method sets the name of the platform.

Parameters:
name - platform name

getClustered

public boolean getClustered()
This method is used to find out if the platform is part of the context cluster. This method can return false even if the platform is part of another cluster, i.e. not the context cluster.

Returns:
true if the platform is part of the context cluster.

setClustered

public void setClustered(boolean clustered)
This method sets whether the platform is part of the context cluster.

Parameters:
clustered - true if the platform is part of the context cluster.

equals

public boolean equals(java.lang.Object other)
overrides default equals() method.


hashCode

public int hashCode()
overrides default hashCode() method.


toString

public java.lang.String toString()
overrides default toString() method.


Openwings API Documentation (v1.1)