fmpp.dataloaders

Class AntDataLoader

java.lang.Object

fmpp.dataloaders.AntDataLoader

All Implemented Interfaces:

DataLoader

Direct Known Subclasses:

AntProjectDataLoader, AntPropertiesDataLoader, AntPropertyDataLoader, AntTaskDataLoader

public abstract class AntDataLoader
extends java.lang.Object
implements DataLoader

Abstract base class of Ant related data loaders.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ANT_TASK The name of the Engine attribute that must store the Ant task object.

Constructor Summary

Constructors

Constructor and Description
AntDataLoader()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	load(Engine eng, java.util.List args) Gets the Ant task object, and invoked load(Engine, List, Task).
protected abstract java.lang.Object	load(Engine eng, java.util.List args, org.apache.tools.ant.Task task) Override this method to implement your Ant related data loader.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_ANT_TASK

public static final java.lang.String ATTRIBUTE_ANT_TASK

The name of the Engine attribute that must store the Ant task object.

See Also:

Constant Field Values

Constructor Detail

AntDataLoader

public AntDataLoader()

Method Detail

load

public java.lang.Object load(Engine eng,
                             java.util.List args)
                      throws java.lang.Exception

Gets the Ant task object, and invoked load(Engine, List, Task).

Specified by:

load in interface DataLoader

args - Arguments that the caller specifies for this directive call. Not null. The implementation should check if it understands all arguments, and it should throw java.lang.IllegalArgumentException if it doesn't.

Returns:

The object that will be accessed in FreeMarker templates. The object can be of any type. FreeMarker will wrap the object so that it is visible as an FTL variable. However, if the object implements freemarker.template.TemplateModel, then it will not be wrapped, as it is already an FTL variable.

Throws:

java.lang.Exception

load

protected abstract java.lang.Object load(Engine eng,
                                         java.util.List args,
                                         org.apache.tools.ant.Task task)
                                  throws java.lang.Exception

Override this method to implement your Ant related data loader.

Throws:

java.lang.Exception