org.apache.tools.ant.taskdefs.optional

Class Native2Ascii

public class Native2Ascii extends MatchingTask

Converts files from native encodings to ASCII.

Since: Ant 1.2

Constructor Summary
Native2Ascii()
Method Summary
voidadd(FileNameMapper fileNameMapper)
A nested filenamemapper
ImplementationSpecificArgumentcreateArg()
Adds an implementation specific command-line argument.
MappercreateMapper()
Defines the FileNameMapper to use (nested mapper element).
voidexecute()
Execute the task
String[]getCurrentArgs()
Returns the (implementation specific) settings given as nested arg elements.
StringgetEncoding()
The value of the reverse attribute.
booleangetReverse()
The value of the reverse attribute.
voidsetDest(File destDir)
Set the destination directory to place converted files into.
voidsetEncoding(String encoding)
Set the encoding to translate to/from.
voidsetExt(String ext)
Set the extension which converted files should have.
voidsetImplementation(String impl)
Choose the implementation for this particular task.
voidsetReverse(boolean reverse)
Flag the conversion to run in the reverse sense, that is Ascii to Native encoding.
voidsetSrc(File srcDir)
Set the source directory in which to find files to convert.

Constructor Detail

Native2Ascii

public Native2Ascii()

Method Detail

add

public void add(FileNameMapper fileNameMapper)
A nested filenamemapper

Parameters: fileNameMapper the mapper to add

Since: Ant 1.6.3

createArg

public ImplementationSpecificArgument createArg()
Adds an implementation specific command-line argument.

Returns: a ImplementationSpecificArgument to be configured

Since: Ant 1.6.3

createMapper

public Mapper createMapper()
Defines the FileNameMapper to use (nested mapper element).

Returns: the mapper to use for file name translations.

Throws: BuildException if more than one mapper is defined.

execute

public void execute()
Execute the task

Throws: BuildException is there is a problem in the task execution.

getCurrentArgs

public String[] getCurrentArgs()
Returns the (implementation specific) settings given as nested arg elements.

Since: Ant 1.6.3

getEncoding

public String getEncoding()
The value of the reverse attribute.

Since: Ant 1.6.3

getReverse

public boolean getReverse()
The value of the reverse attribute.

Since: Ant 1.6.3

setDest

public void setDest(File destDir)
Set the destination directory to place converted files into.

Parameters: destDir directory to place output file into.

setEncoding

public void setEncoding(String encoding)
Set the encoding to translate to/from. If unset, the default encoding for the JVM is used.

Parameters: encoding String containing the name of the Native encoding to convert from or to.

setExt

public void setExt(String ext)
Set the extension which converted files should have. If unset, files will not be renamed.

Parameters: ext File extension to use for converted files.

setImplementation

public void setImplementation(String impl)
Choose the implementation for this particular task.

Parameters: impl the name of the implemenation

Since: Ant 1.6.3

setReverse

public void setReverse(boolean reverse)
Flag the conversion to run in the reverse sense, that is Ascii to Native encoding.

Parameters: reverse True if the conversion is to be reversed, otherwise false;

setSrc

public void setSrc(File srcDir)
Set the source directory in which to find files to convert.

Parameters: srcDir directory to find input file in.

Copyright