oracle.jdeveloper.deploy.meta.pattern

Class ChainOfR<T,V,S>

java.lang.Object

oracle.jdeveloper.deploy.meta.pattern.ChainOfR<T,V,S>

All Implemented Interfaces:

Copyable

public class ChainOfR<T,V,S>
extends java.lang.Object
implements Copyable

Implements the Chain Of Responsibility pattern. This class also allows labelling of each node in the chain. The label is of type T. The label can be used to specify the starting point of a request. Nodes of type V can be added to the chain. S is the type of request that will be handled by each RequestHandler.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChainOfR.DuplicateIndexException
static class	ChainOfR.IndexNotFoundException
static interface	ChainOfR.RequestHandler<V,S>

Constructor Summary

Constructors

Constructor and Description
ChainOfR(ChainOfR.RequestHandler<V,S> handler)

Method Summary

Modifier and Type	Method and Description
void	add(T chainIndex, T chainParentIndex, V userObject) Adds a new User Object to a chain.
java.lang.Object	copyTo(java.lang.Object target) Shallow copies the data structure that implements the ChainOfR pattern.
protected void	copyToImpl(ChainOfR<T,V,S> copy)
V	get(T chainIndex)
V	getHandlingObject(T startNodeIndex, S request) Same as handle(), but return the user object that handled the request.
V	getParent(T chainIndex)
T	getParentLabel(T chainIndex)
boolean	handle(T startNodeIndex, S request) Handle the command, starting from a certain node and traversing referred nodes.
void	purge() Delete all nodes in this chain, intended for testing.
void	replace(T chainIndex, V userObject) Replace an existing User Object with a new one.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainOfR

public ChainOfR(ChainOfR.RequestHandler<V,S> handler)

Method Detail

handle

public boolean handle(T startNodeIndex,
                      S request)
               throws java.lang.Exception

Handle the command, starting from a certain node and traversing referred nodes.

Returns:

true if the request was handled, null if it fell off the chain

Throws:

ChainOfR.IndexNotFoundException - if the starting index cannot be found.

java.lang.Exception - any other exception raised when handling the request.

getHandlingObject

public V getHandlingObject(T startNodeIndex,
                           S request)
                    throws java.lang.Exception

Same as handle(), but return the user object that handled the request.

Returns:

the user object that handled the request, null if the request was not handled.

Throws:

ChainOfR.IndexNotFoundException - if startNodeIndex is not found

java.lang.Exception - if an error occurs when processing the request.

add

public void add(T chainIndex,
                T chainParentIndex,
                V userObject)
         throws ChainOfR.DuplicateIndexException,
                MetadataException

Adds a new User Object to a chain.

Parameters:

chainIndex - a label for the new handler

chainParentIndex - label for the parent for this handler

userObject - a user object that should be associated with this handler

Throws:

MetadataException - if chainIndex, or chainParentIndex cannot be found.

ChainOfR.DuplicateIndexException

replace

public void replace(T chainIndex,
                    V userObject)
             throws MetadataException

Replace an existing User Object with a new one.

Parameters:

chainIndex -

userObject -

Throws:

MetadataException - if chainIndex is not found

getParentLabel

public T getParentLabel(T chainIndex)
                 throws ChainOfR.IndexNotFoundException

Throws:

ChainOfR.IndexNotFoundException

getParent

public V getParent(T chainIndex)
            throws ChainOfR.IndexNotFoundException

Throws:

ChainOfR.IndexNotFoundException

get

public V get(T chainIndex)
      throws ChainOfR.IndexNotFoundException

Throws:

ChainOfR.IndexNotFoundException

purge

public void purge()

Delete all nodes in this chain, intended for testing.

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Shallow copies the data structure that implements the ChainOfR pattern. None of the user-supplied objects are copied. This is useful when a temporary modification of the structure of the chain is required, for example to insert or append new elements.

Specified by:

copyTo in interface Copyable

Parameters:

target -

Returns:

copyToImpl

protected void copyToImpl(ChainOfR<T,V,S> copy)