de.dokutransdata.antlatex
Class MakeindexTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          de.dokutransdata.antlatex.SimpleExternalTask
              de.dokutransdata.antlatex.MakeindexTask

All Implemented Interfaces:

java.lang.Cloneable

public class MakeindexTask
extends SimpleExternalTask

Simple Task for Makeindex.

Field Summary

static java.lang.String

RCS_ID

Fields inherited from class de.dokutransdata.antlatex.SimpleExternalTask

antTask, If, run, theCommand, thePath, verbose, workingDir

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

MakeindexTask()

MakeindexTask(java.util.List newIdx)

Method Summary

void	add(FileSet f) Callback-Methode um eingeschachtelte <fileset>-Elemente einfügen zu können.
void	execute()
java.util.List	getFiles()
java.util.List	getIdxFiles()
java.lang.String	getIdxStyle()
java.lang.String	getMakeIndexPath()
java.lang.String	getOutFile()
java.lang.String	getProtocolFile()
boolean	isInLoop()
int	run() Stellt aus den Attributen die Parameter fuer den Aufruf von Makeindex zusammen und ruft anschliessend das externe Programm auf.
void	setCompressIntermediateBlanks(boolean flag)
void	setGermanWordOrder(boolean flag)
void	setIdxFiles(java.util.List newValue)
void	setIdxStyle(java.lang.String newValue) Für den Parameter -s wird der Name der Styledatei übergeben.
void	setInLoop(boolean inLoop)
void	setLetterOrder(boolean flag)
void	setOutFile(java.lang.String newValue) Für den Parameter -o wird der Name der Ausgabedatei übergeben.
void	setPageRangeFormation(boolean flag)
void	setProtocolFile(java.lang.String newValue) Für den Parameter -t wird der Name der Protokolldatei übergeben.
void	setStartingPageNumber(java.lang.String newValue)
java.lang.String	toString()

Methods inherited from class de.dokutransdata.antlatex.SimpleExternalTask

getCommand, getIf, getPath, getRun, invoke, setCommand, setIf, setPath, setRun, setVerbose, setWorkingDir

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

Field Detail

RCS_ID

public static final java.lang.String RCS_ID

See Also:

Constant Field Values

Constructor Detail

MakeindexTask

public MakeindexTask(java.util.List newIdx)

MakeindexTask

public MakeindexTask()

Method Detail

setCompressIntermediateBlanks

public void setCompressIntermediateBlanks(boolean flag)

setGermanWordOrder

public void setGermanWordOrder(boolean flag)

setLetterOrder

public void setLetterOrder(boolean flag)

setStartingPageNumber

public void setStartingPageNumber(java.lang.String newValue)
                           throws BuildException

Parameters:

newValue - Kann ein integer, 'any', 'even', 'odd' sein.

Throws:

BuildException

setPageRangeFormation

public void setPageRangeFormation(boolean flag)

isInLoop

public final boolean isInLoop()

Returns:

Returns the inLoop.

setInLoop

public final void setInLoop(boolean inLoop)

Parameters:

inLoop - The inLoop to set.

getFiles

public final java.util.List getFiles()

Returns:

Returns the files.

add

public void add(FileSet f)

Callback-Methode um eingeschachtelte <fileset>-Elemente einfügen zu können.

Parameters:

f - from build.xml

execute

public final void execute()
                   throws BuildException

Overrides:

execute in class Task

Throws:

BuildException

getIdxFiles

public java.util.List getIdxFiles()

getIdxStyle

public java.lang.String getIdxStyle()

getMakeIndexPath

public java.lang.String getMakeIndexPath()

getOutFile

public java.lang.String getOutFile()

getProtocolFile

public java.lang.String getProtocolFile()

run

public final int run()
              throws BuildException

Stellt aus den Attributen die Parameter fuer den Aufruf von Makeindex zusammen und ruft anschliessend das externe Programm auf.

Returns:

Rueckgabewert des externen Programms

Throws:

BuildException

setIdxFiles

public void setIdxFiles(java.util.List newValue)

Parameters:

newValue - Liste der Dateien zum Scannen.

setIdxStyle

public void setIdxStyle(java.lang.String newValue)
                 throws BuildException

Für den Parameter -s wird der Name der Styledatei übergeben.

Parameters:

newValue - Name der Styledatei

Throws:

BuildException

setOutFile

public void setOutFile(java.lang.String newValue)
                throws BuildException

Für den Parameter -o wird der Name der Ausgabedatei übergeben.

Parameters:

newValue - Name der Ausgabedatei

Throws:

BuildException

setProtocolFile

public void setProtocolFile(java.lang.String newValue)
                     throws BuildException

Für den Parameter -t wird der Name der Protokolldatei übergeben.

Parameters:

newValue - Name der Datei

Throws:

BuildException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object