org.xins.common.ant

Class CreateExampleTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.xins.common.ant.CreateExampleTask

All Implemented Interfaces:

Cloneable

public class CreateExampleTask
extends Task

Apache Ant task that generates the specification code of an example based on the request URL.

Since:

XINS 1.4.0

Version:

$Revision: 1.22 $ $Date: 2011/01/19 18:13:39 $

Author:

Anthony Goubard

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Constructors

Constructor and Description
CreateExampleTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Called by the project to let the task do its work.
void	init()
void	setExampleProperty(String exampleProperty) Sets the name of the property in which the result should be stored.
void	setFunctionProperty(String functionProperty) Sets the name of the property in which the name of the function should be stored.
void	setRequestURL(String requestURL) Sets the URL to call the function.
void	setXslLocation(String xslLocation) Sets the location of the XSL style sheet to use to create the example.

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateExampleTask

public CreateExampleTask()

Method Detail

setRequestURL

public void setRequestURL(String requestURL)

Sets the URL to call the function.

Parameters:

requestURL - the name of the property to store the uppercase value.

setExampleProperty

public void setExampleProperty(String exampleProperty)

Sets the name of the property in which the result should be stored.

Parameters:

exampleProperty - the name of the property in which the result should be stored.

setFunctionProperty

public void setFunctionProperty(String functionProperty)

Sets the name of the property in which the name of the function should be stored.

Parameters:

functionProperty - the name of the property in which the result should be stored.

setXslLocation

public void setXslLocation(String xslLocation)

Sets the location of the XSL style sheet to use to create the example.

Parameters:

xslLocation - the name of the property in which the result should be stored.

init

public void init()
          throws BuildException

Overrides:

init in class Task

Throws:

BuildException

execute

public void execute()
             throws BuildException

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

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build.