org.apache.tools.ant.taskdefs.optional.native2ascii

Class DefaultNative2Ascii

public abstract class DefaultNative2Ascii extends Object implements Native2AsciiAdapter

encapsulates the handling common to diffent Native2Asciiadapter implementations.

Since: Ant 1.6.3

Constructor Summary
DefaultNative2Ascii()
No-arg constructor.
Method Summary
protected voidaddFiles(Commandline cmd, ProjectComponent log, File src, File dest)
Adds source and dest files to the command line.
booleanconvert(Native2Ascii args, File srcFile, File destFile)
Splits the task into setting up the command line switches
protected abstract booleanrun(Commandline cmd, ProjectComponent log)
Executes the command.
protected voidsetup(Commandline cmd, Native2Ascii args)
Sets up the initial command line.

Constructor Detail

DefaultNative2Ascii

public DefaultNative2Ascii()
No-arg constructor.

Method Detail

addFiles

protected void addFiles(Commandline cmd, ProjectComponent log, File src, File dest)
Adds source and dest files to the command line.

This implementation adds them without any leading qualifiers, source first.

Parameters: cmd Command line to add to log provides access to Ant's logging system. src the source file dest the destination file

Throws: BuildException if there was a problem.

convert

public final boolean convert(Native2Ascii args, File srcFile, File destFile)
Splits the task into setting up the command line switches

Parameters: args the native 2 ascii arguments. srcFile the source file. destFile the destination file.

Returns: run if the conversion was successful.

Throws: BuildException if there is a problem. (delegated to {@link #setup setup}), adding the file names (delegated to {@link #addFiles addFiles}) and running the tool (delegated to {@link #run run}).

run

protected abstract boolean run(Commandline cmd, ProjectComponent log)
Executes the command.

Parameters: cmd Command line to execute log provides access to Ant's logging system.

Returns: whether execution was successful

Throws: BuildException if there was a problem.

setup

protected void setup(Commandline cmd, Native2Ascii args)
Sets up the initial command line.

only the -encoding argument and nested arg elements get handled here.

Parameters: cmd Command line to add to args provides the user-setting and access to Ant's logging system.

Throws: BuildException if there was a problem.