org.mapfish.print.processor

Class ProcessorDependency

java.lang.Object

org.mapfish.print.processor.ProcessorDependency

public class ProcessorDependency
extends java.lang.Object

Models a dependency between two processors.

Constructor Summary

Constructors

Constructor and Description
ProcessorDependency(java.lang.Class<? extends Processor<?,?>> required, java.lang.Class<? extends Processor<?,?>> dependent) Constructor.
ProcessorDependency(java.lang.Class<? extends Processor<?,?>> required, java.lang.Class<? extends Processor<?,?>> dependent, java.util.Set<java.lang.String> commonInputs) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addCommonInput(java.lang.String inputName) Add a common input to this dependency.
java.util.Set<java.lang.String>	getCommonInputs() The inputs that both processors must have in common.
java.lang.Class<? extends Processor<?,?>>	getDependent() Returns the processor which requires the other to be executed first.
java.lang.Class<? extends Processor<?,?>>	getRequired() Returns the processor which is required to be executed before the other.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorDependency

public ProcessorDependency(java.lang.Class<? extends Processor<?,?>> required,
                           java.lang.Class<? extends Processor<?,?>> dependent,
                           java.util.Set<java.lang.String> commonInputs)

Constructor. The processor dependent requires the processor required.

Parameters:

required - The processor which is required to be executed before the other.

dependent - The processor which requires the other to be executed first.

commonInputs - The dependency is only enforced if the two processors have these inputs in common.

ProcessorDependency

public ProcessorDependency(java.lang.Class<? extends Processor<?,?>> required,
                           java.lang.Class<? extends Processor<?,?>> dependent)

Constructor. The processor dependent requires the processor required.

Parameters:

required - The processor which is required to be executed before the other.

dependent - The processor which requires the other to be executed first.

Method Detail

getRequired

public final java.lang.Class<? extends Processor<?,?>> getRequired()

Returns the processor which is required to be executed before the other.

getDependent

public final java.lang.Class<? extends Processor<?,?>> getDependent()

Returns the processor which requires the other to be executed first.

getCommonInputs

public final java.util.Set<java.lang.String> getCommonInputs()

The inputs that both processors must have in common.

addCommonInput

public final void addCommonInput(java.lang.String inputName)

Add a common input to this dependency.

Parameters:

inputName - the name of the input to add

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object