de.unkrig.html2txt

Class AntTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

de.unkrig.html2txt.AntTask

All Implemented Interfaces:

Cloneable

public class AntTask
extends org.apache.tools.ant.Task

Converts one or more HTML files into plain text files.

The following attributes are mutually exclusive:

setTofile(File)

setTodir(File)

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
AntTask()

Method Summary

Modifier and Type	Method and Description
void	addConfigured(org.apache.tools.ant.types.ResourceCollection value) Resources to convert.
void	execute() The ANT task "execute" method.
void	setFile(File value) The file that contains the HTML document to convert.
void	setInputCharset(String charsetName) The charset to use when reading HTML input files.
void	setOutputCharset(String charsetName) The charset to use when writing text input files.
void	setPageLeftMargin(int value) The number of spaces that preceeds each line of output.
void	setPageRightMargin(int value) The maximum length of output lines is "pageWidth - rightMarginWidth".
void	setPageWidth(int value) The maximum length of output lines is "pageWidth - rightMarginWidth".
void	setTodir(File value) The directory where the output file(s) will be created.
void	setTofile(File value) The file that contains generated plain text.

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

Constructor Detail

AntTask

public AntTask()

Method Detail

setFile

public void setFile(File value)

The file that contains the HTML document to convert.

setTofile

public void setTofile(File value)

The file that contains generated plain text. Only allowed if exactly one HTML is converted.

setTodir

public void setTodir(File value)

The directory where the output file(s) will be created. The name of each output file(s) will be that of the input file, less the ".html" suffix (if any), plus an ".txt" extension.

The default is the source resource's base directory (if any), otherwise the project's base directory.

setPageLeftMargin

public void setPageLeftMargin(int value)

The number of spaces that preceeds each line of output.

setPageRightMargin

public void setPageRightMargin(int value)

The maximum length of output lines is "pageWidth - rightMarginWidth".

The default value is @"1" in order to avoid extra line wraps on certain terminals.

setPageWidth

public void setPageWidth(int value)

The maximum length of output lines is "pageWidth - rightMarginWidth".

Defaults to the value of the environment variable "$COLUMNS", or, if that is not set, to 80.

setInputCharset

public void setInputCharset(String charsetName)

The charset to use when reading HTML input files. Defaults to the JVM default charset.

setOutputCharset

public void setOutputCharset(String charsetName)

The charset to use when writing text input files. Defaults to the JVM default charset.

addConfigured

public void addConfigured(org.apache.tools.ant.types.ResourceCollection value)

Resources to convert.

execute

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

The ANT task "execute" method.

Overrides:

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

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()