org.opendaylight.controller.concepts.transform

Class CompositeClassBasedTransformer<I,P>

java.lang.Object

org.opendaylight.controller.concepts.transform.CompositeClassBasedTransformer<I,P>

Type Parameters:

I - Input super-type

P - Product

All Implemented Interfaces:

AggregateTransformer<I,P>, InputClassBasedTransformer<I,I,P>, Transformer<I,P>

public abstract class CompositeClassBasedTransformer<I,P>
extends Object
implements InputClassBasedTransformer<I,I,P>, AggregateTransformer<I,P>

Transformer which aggregates multiple implementations of InputClassBasedTransformer. The transformation process is driven by Class of input. The selection of used InputClassBasedTransformer is done by using the Class of input as a key to select the transformer. This approach provides quick resolution of transformer, but does not support registering a super type of input to provide transformation support for all subclasses, one must register a new instance of transformer for each valid input class. If you need more flexible selection of transformation consider using CompositeConditionalTransformer which is slower but most flexible or RuleBasedTransformer which provides declarative approach for transformation. See transform(Object) for more information about tranformation process.

Author:

Tony Tkacik

Constructor Summary

Constructors

Constructor and Description
CompositeClassBasedTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTransformer(InputClassBasedTransformer<I,? extends I,P> transformer) Registers a new transformer.
void	removeTransformer(InputClassBasedTransformer<I,? extends I,P> transformer) Removes an registered transformer.
P	transform(I input) Transforms an input into instance of Product class.
Collection<P>	transformAll(Collection<? extends I> inputs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.controller.concepts.transform.InputClassBasedTransformer

getInputClass

Constructor Detail

CompositeClassBasedTransformer

public CompositeClassBasedTransformer()

Method Detail

transform

public P transform(I input)

Transforms an input into instance of Product class. The final registered transformer is the one which match following condition: input.getClass() == transformer.getInputClass() This means that transformers are not resolved by class hierarchy, only selected based on final class of the input. If you need more flexible selection of transformation consider using CompositeConditionalTransformer which is slower but more flexible.

Specified by:

transform in interface Transformer<I,P>

Parameters:

input - Input which drives transformation

Returns:

Instance of product which was created from supplied input.

addTransformer

public void addTransformer(InputClassBasedTransformer<I,? extends I,P> transformer)
                    throws IllegalStateException

Registers a new transformer. The transformer is registered for class returned by InputClassBasedTransformer.getInputClass(). Only one transformer can be registered for particular input class.

Throws:

IllegalStateException

removeTransformer

public void removeTransformer(InputClassBasedTransformer<I,? extends I,P> transformer)
                       throws IllegalArgumentException

Removes an registered transformer. Note: Removal is currently unsupported.

Parameters:

transformer - Tranformer to be removed.

Throws:

IllegalArgumentException - If the provided transformer is null or is not registered.

transformAll

public Collection<P> transformAll(Collection<? extends I> inputs)

Specified by:

transformAll in interface AggregateTransformer<I,P>