planet.commonapi.factory
Interface NodeHandleFactory

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
NodeHandleFactoryImpl

public interface NodeHandleFactory
extends java.io.Serializable

It's a factory for NodeHandles abstraction. It pretends build NodeHandles of any class, using the factory method pattern design.

Any future implementation must contain the no argument constructor.

Author:
Jordi Pujol
See Also:
NodeHandle

Method Summary
 NodeHandle buildNodeHandle(Id nodeId, boolean alive)
          Builds a NodeHandle using the default NodeHandle class.
 NodeHandleFactory setValues(java.lang.Class nodeHandle)
          Sets the initial values for the NodeHandleFactory.
 

Method Detail

setValues

public NodeHandleFactory setValues(java.lang.Class nodeHandle)
                            throws InitializationException
Sets the initial values for the NodeHandleFactory.

Parameters:
nodeHandle - Class reference to build new NodeHandles.
Returns:
The same instance once it has been updated.
Throws:
InitializationException - if some error occurs during the initialization process.

buildNodeHandle

public NodeHandle buildNodeHandle(Id nodeId,
                                  boolean alive)
                           throws InitializationException
Builds a NodeHandle using the default NodeHandle class.

Returns:
A new instance of the default NodeHandle.
Throws:
InitializationException