org.polago.deployconf.task.filter

Class FilterTask

java.lang.Object

org.polago.deployconf.task.AbstractTask

org.polago.deployconf.task.filter.FilterTask

All Implemented Interfaces:

Task

public class FilterTask
extends AbstractTask

Deployment Task for filtering tokens in a file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOM_ELEMENT_TASK Task element name in config file.

Fields inherited from class org.polago.deployconf.task.AbstractTask

DOM_ATTRIBUTE_GROUP, DOM_ATTRIBUTE_IF, DOM_ATTRIBUTE_PATH, DOM_ELEMENT_CONDITION, DOM_ELEMENT_DEFAULT, DOM_ELEMENT_DESCRIPTION, DOM_ELEMENT_VALUE

Constructor Summary

Constructors

Constructor and Description
FilterTask(ConfigGroupManager groupManager) Public Constructor.

Method Summary

Modifier and Type	Method and Description
void	apply(InputStream source, OutputStream destination) Apply this Task by copying source to destination.
boolean	configureInteractively(InteractiveConfigurer configurer, boolean force) Configure the task by asking the user for inputs.
void	deserialize(org.jdom2.Element root) Load the task from a list of JDOM Elements.
String	getSerializedName() Gets the serialized Task Name.
Set<FilterToken>	getTokens() Gets the tokens property value.
boolean	isConfigured() Determine if the Task is completely configured.
void	merge(Task other) Merge another Task with this one.
void	serialize(org.jdom2.Element node) Serialize this Task to a JDOM Element.
String	toString()

Methods inherited from class org.polago.deployconf.task.AbstractTask

createJDOMCDATAElement, createJDOMElement, createJDOMTextElement, equals, evaluateCondition, expandPropertyExpression, getGroupManager, getPath, hashCode, setPath

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DOM_ELEMENT_TASK

public static final String DOM_ELEMENT_TASK

Task element name in config file.

See Also:

Constant Field Values

Constructor Detail

FilterTask

public FilterTask(ConfigGroupManager groupManager)

Public Constructor.

Parameters:

groupManager - the groupManager to use

Method Detail

deserialize

public void deserialize(org.jdom2.Element root)
                 throws IOException

Load the task from a list of JDOM Elements.

Specified by:

deserialize in interface Task

Overrides:

deserialize in class AbstractTask

Parameters:

root - the JDOM Element to use for configuring this instance

Throws:

IOException - indicating IO Error

serialize

public void serialize(org.jdom2.Element node)
               throws IOException

Serialize this Task to a JDOM Element.

Specified by:

serialize in interface Task

Overrides:

serialize in class AbstractTask

Parameters:

node - the JDOM Element to serialize to

Throws:

IOException - indicating IO Error

getTokens

public Set<FilterToken> getTokens()

Gets the tokens property value.

Returns:

the current value of the tokens property

merge

public void merge(Task other)

Merge another Task with this one.

Parameters:

other - the other Task

isConfigured

public boolean isConfigured()
                     throws IOException

Determine if the Task is completely configured.

Returns:

true if the Task is completely configured

Throws:

IOException - indicating IO Error

configureInteractively

public boolean configureInteractively(InteractiveConfigurer configurer,
                                      boolean force)
                               throws Exception

Configure the task by asking the user for inputs.

Parameters:

configurer - the InteractiveConfigurer to use

force - if true, the Task is always configured

Returns:

true if the task was configured

Throws:

Exception - indicating processing failure

getSerializedName

public String getSerializedName()

Gets the serialized Task Name.

Returns:

the serialized name of this task

apply

public void apply(InputStream source,
                  OutputStream destination)
           throws Exception

Apply this Task by copying source to destination.

Parameters:

source - the Input stream

destination - the Output stream

Throws:

Exception - indicating processing failure

toString

public String toString()

Overrides:

toString in class Object