Openwings API Documentation (v1.1)

net.openwings.component.utilities
Class ServiceDescriptor

java.lang.Object
  extended bynet.openwings.component.utilities.ServiceDescriptor
All Implemented Interfaces:
java.io.Serializable

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

This class is used to provide metadata about a service being implemented or used by a component.

See Also:
Serialized Form

Constructor Summary
ServiceDescriptor()
          Default constructor - empty
ServiceDescriptor(java.lang.Class serviceInterface, UniqueID uniqueID, boolean implementsInterface)
          This is the primary constructor for the ServiceDescriptor class.
 
Method Summary
 boolean equals(java.lang.Object obj)
          overrides default equals() method.
 boolean getImplementsInterface()
          This method tells whether this service is implemented locally or remotely.
 java.lang.String getName()
          This method returns the name of the service.
 java.lang.Class getServiceInterface()
          This method returns the class of the service interface.
 UniqueID getUniqueID()
          This method returns the unique identifier for the service.
 int hashCode()
          overrides default hashCode() method.
 void setImplementsInterface(boolean implementsInterface)
          This method tells whether this service is implemented locally or remotely.
 void setServiceInterface(java.lang.Class serviceInterface)
          This method sets the class of the service interface.
 void setUniqueID(UniqueID uniqueID)
          This method sets the unique identifier for the service.
 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

ServiceDescriptor

public ServiceDescriptor()
Default constructor - empty


ServiceDescriptor

public ServiceDescriptor(java.lang.Class serviceInterface,
                         UniqueID uniqueID,
                         boolean implementsInterface)
This is the primary constructor for the ServiceDescriptor class.

Parameters:
serviceInterface - the interface this service implments.
uniqueID - the unique id of this service
implementsInterface - true if the component implements the interface, false if the component calls the interface
Method Detail

getName

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

Returns:
String class name of the inteface

getUniqueID

public UniqueID getUniqueID()
This method returns the unique identifier for the service.

Returns:
unique identifier for the service.

setUniqueID

public void setUniqueID(UniqueID uniqueID)
This method sets the unique identifier for the service.

Parameters:
uniqueID - unique identifier for the service.

getServiceInterface

public java.lang.Class getServiceInterface()
This method returns the class of the service interface.

Returns:
Class class of the service interface.

setServiceInterface

public void setServiceInterface(java.lang.Class serviceInterface)
This method sets the class of the service interface.

Parameters:
serviceInterface - class of the service interface.

getImplementsInterface

public boolean getImplementsInterface()
This method tells whether this service is implemented locally or remotely. By getting the associated ConnectorDescriptors one can tell exactly what proxy this interface repesents.

Returns:
true if the component implements the interface, false if the component calls the interface

setImplementsInterface

public void setImplementsInterface(boolean implementsInterface)
This method tells whether this service is implemented locally or remotely. By getting the associated ConnectorDescriptors one can tell exactly what proxy this interface repesents.

Parameters:
implementsInterface - true if the component implements the interface, false if the component calls the interface

equals

public boolean equals(java.lang.Object obj)
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)