de.bsd.x2svg.ant
Class X2SvgTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          de.bsd.x2svg.ant.X2SvgBaseTask
              de.bsd.x2svg.ant.X2SvgTask

All Implemented Interfaces:

java.lang.Cloneable

public class X2SvgTask
extends X2SvgBaseTask

The main X2SVG task, that is responsible for global settings management. and execution of parsing sub-tasks.

Since:

1.1

Author:

gfloodgate

Field Summary

private Output	output The output format type collection.
private RuntimeParameters	runtimeParameters The global runtime properties used by all sub-tasks.
private java.util.ArrayList<X2SvgSubTask>	tasks Create a hold for sub-task objects that need to be executed.

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

X2SvgTask()

Method Summary

void	addConfiguredConvertor(ConvertorSubTask task) Add a Convertor instance as a task to execure.
void	addConfiguredOutput(Output output) Add an Output instance as the collection of output formats to be used by X2SVG.
void	addConfiguredParser(ParserSubTask task) Add a Parser instance as a task to execure.
void	execute()
java.lang.String	getPropertiesLocation() Get the x2svg properties location.
boolean	isDebugEnabled() Is debug (verbose output mode) enabled for this task ?
void	setDebugEnabled(boolean isDebugEnabled) Set wether or not debug mode should be activated.
void	setPropertiesLocation(java.lang.String propertiesLocation) Set the x2svg properties location.

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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

Field Detail

tasks

private final java.util.ArrayList<X2SvgSubTask> tasks

Create a hold for sub-task objects that need to be executed.

output

private Output output

The output format type collection.

runtimeParameters

private RuntimeParameters runtimeParameters

The global runtime properties used by all sub-tasks.

Constructor Detail

X2SvgTask

public X2SvgTask()

Method Detail

isDebugEnabled

public boolean isDebugEnabled()

Is debug (verbose output mode) enabled for this task ?

Returns:

true, If debug (verbose mode) should be enabled for this task, false otherwise.

setDebugEnabled

public void setDebugEnabled(boolean isDebugEnabled)

Set wether or not debug mode should be activated.

Parameters:

isDebugEnabled - true, If debug should be enabled, false otherwise.

getPropertiesLocation

public java.lang.String getPropertiesLocation()

Get the x2svg properties location.

Returns:

Get location of the properties file specified globally.

setPropertiesLocation

public void setPropertiesLocation(java.lang.String propertiesLocation)

Set the x2svg properties location.

Parameters:

propertiesLocation - The location of the x2svg.properties file to use.

addConfiguredOutput

public void addConfiguredOutput(Output output)

Add an Output instance as the collection of output formats to be used by X2SVG.

Parameters:

output - The output conversion type instance.

addConfiguredParser

public void addConfiguredParser(ParserSubTask task)

Add a Parser instance as a task to execure.

Parameters:

task - The prepared task, ready for execution later.

addConfiguredConvertor

public void addConfiguredConvertor(ConvertorSubTask task)

Add a Convertor instance as a task to execure.

Parameters:

task - The prepared task, ready for execution later.

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException