net.dpml.transit.tools
Class GetTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          net.dpml.transit.tools.TransitTask
              net.dpml.transit.tools.GetTask

public class GetTask

extends net.dpml.transit.tools.TransitTask

The get task handles the retrival of a rresource and the binding of the resource filename to a project property.

Version:

1.0.0

Author:

The Digital Product Meta Library

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

GetTask()

Method Summary

void	execute() Load the resource and assign the locally cached file path to the supplied property name.
static void	initialize(Task task) Initialize the supplied task.
void	setProject(Project project) Set the project.
void	setProperty(String name) Set the name of a property into which the local file path will be assigned.
void	setUri(String uri) Set the artifact uri of the plugin from which the task is to be loaded.

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject

Methods inherited from class java.lang.Object

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

Constructor Detail

GetTask

public GetTask()

Method Detail

setProject

public void setProject(Project project)

Set the project.

Parameters:

project - the current project

setUri

public void setUri(String uri)

Set the artifact uri of the plugin from which the task is to be loaded.

Parameters:

uri - an artifact plugin uri

setProperty

public void setProperty(String name)

Set the name of a property into which the local file path will be assigned.

Parameters:

name - the ant property name

execute

public void execute()
             throws BuildException

Load the resource and assign the locally cached file path to the supplied property name.

Throws:

BuildException - if an error occurs during resource resolution

initialize

public static void initialize(Task task)
                       throws BuildException

Initialize the supplied task.

Parameters:

task - the task to initialize

Throws:

BuildException - if an initialization error occurs