org.xins.common.ant
Class CallXINSTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.xins.common.ant.CallXINSTask

public class CallXINSTask

extends Task

Apache Ant task that call a function of a XINS API, the result is stored in Ant properties.

Since:

XINS 1.5.0

Version:

$Revision: 1.7 $ $Date: 2006/10/31 15:00:52 $

Author:

Anthony Goubard

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

CallXINSTask()
Constructs a new CallTargetsTask instance.

Method Summary

Property	createParam() Adds an input parameter.
void	execute() Called by the project to let the task do its work.
void	setApiLocation(String apiLocation) Sets the URL location of the API.
void	setFunction(String function) Sets the name of the API function to call.
void	setPrefix(String prefix) Sets the prefix for the result properties.

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, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CallXINSTask

public CallXINSTask()

Constructs a new CallTargetsTask instance.

Method Detail

setFunction

public void setFunction(String function)

Sets the name of the API function to call.

Parameters:

function - the name of the function to call, can be null.

setApiLocation

public void setApiLocation(String apiLocation)

Sets the URL location of the API.

Parameters:

apiLocation - the URL location of the API without any parameters, cannot be null.

setPrefix

public void setPrefix(String prefix)

Sets the prefix for the result properties.

Parameters:

prefix - the prefix for the result properties.

createParam

public Property createParam()

Adds an input parameter.

Returns:

the input parameters.

execute

public void execute()
             throws BuildException

Called by the project to let the task do its work.

Throws:

BuildException - if something goes wrong with the build.