de.dokutransdata.antlatex
Class SimpleExternalTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by de.dokutransdata.antlatex.SimpleExternalTask
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
BibTeXTask, GlossTeXTask, LaTeX, LaTeXTask, MakeindexTask

public class SimpleExternalTask
extends Task


Field Summary
protected  Task antTask
          Ant-Umgebung zum Task.
protected  java.lang.String If
          Deprecated.  
static java.lang.String RCS_ID
           
protected  boolean run
          Schalter der bei geschachtelten Tasks regeln soll, ob der Task ausgeführt wird oder nicht.
protected  java.lang.String theCommand
          Kommando des auszuführenden Befehls (evtl. inklusive Pfad).
protected  java.lang.String thePath
          Nur der Pfad zu einem bekannten Befehlt, wie z.B.
protected  boolean verbose
          Soll an den externen Task durchgereicht werden, damit dieser etwas erzählt.
protected  java.io.File workingDir
          Arbeitsverzeichnis für den Task, wird normalerweise mit baseDir gleichgesetzt.
 
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
SimpleExternalTask()
           
 
Method Summary
 java.lang.String getCommand()
           
 java.lang.String getIf()
           
 java.lang.String getPath()
           
 boolean getRun()
           
protected  int invoke(java.lang.String cmd, java.util.List args)
           
 void setCommand(java.lang.String newValue)
           
 void setIf(java.lang.String property)
           
 void setPath(java.lang.String newValue)
           
 void setRun(boolean property)
           
 void setVerbose(boolean newValue)
           
 void setWorkingDir(java.io.File newValue)
           
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, execute, 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

RCS_ID

public static final java.lang.String RCS_ID
See Also:
Constant Field Values

workingDir

protected java.io.File workingDir
Arbeitsverzeichnis für den Task, wird normalerweise mit baseDir gleichgesetzt.


verbose

protected boolean verbose
Soll an den externen Task durchgereicht werden, damit dieser etwas erzählt.


If

protected java.lang.String If
Deprecated. 

run

protected boolean run
Schalter der bei geschachtelten Tasks regeln soll, ob der Task ausgeführt wird oder nicht. Normalerweise wird der Task ausgeführt.


theCommand

protected java.lang.String theCommand
Kommando des auszuführenden Befehls (evtl. inklusive Pfad).


thePath

protected java.lang.String thePath
Nur der Pfad zu einem bekannten Befehlt, wie z.B. LaTeX.


antTask

protected Task antTask
Ant-Umgebung zum Task.

Constructor Detail

SimpleExternalTask

public SimpleExternalTask()
Method Detail

setRun

public void setRun(boolean property)

getRun

public boolean getRun()

setIf

public void setIf(java.lang.String property)

getIf

public java.lang.String getIf()

setVerbose

public void setVerbose(boolean newValue)

setWorkingDir

public final void setWorkingDir(java.io.File newValue)

setCommand

public final void setCommand(java.lang.String newValue)
                      throws BuildException
Throws:
BuildException

getCommand

public final java.lang.String getCommand()

setPath

public final void setPath(java.lang.String newValue)

getPath

public final java.lang.String getPath()

invoke

protected final int invoke(java.lang.String cmd,
                           java.util.List args)
                    throws BuildException
Parameters:
cmd - Das Kommando, dass zur Ausführung kommen soll, evtl. wird der Pfad ergänzt.
args - Argumente für das Kommando
Returns:
Bei Misserfolg wird eine -1 zurückgegeben, ansonsten der Rückgabewert des aufgerufenen Programmes.
Throws:
BuildException - Wenn das Kommando nicht ausgeführt werden kann.