Package org.apache.tools.ant.taskdefs.optional.i18n

Class Translate

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MatchingTask

org.apache.tools.ant.taskdefs.optional.i18n.Translate

All Implemented Interfaces:

Cloneable, SelectorContainer

public class Translate
extends MatchingTask

Translates text embedded in files using Resource Bundle files. Since ant 1.6 preserves line endings

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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	Description
Translate()

Method Summary

Modifier and Type	Method	Description
void	addFileset(FileSet set)	Adds a set of files to translate as a nested fileset element.
void	execute()	Check attributes values, load resource map and translate
void	setBundle(String bundle)	Sets Family name of resource bundle; required.
void	setBundleCountry(String bundleCountry)	Sets locale specific country of resource bundle; optional.
void	setBundleEncoding(String bundleEncoding)	Sets Resource Bundle file encoding scheme; optional.
void	setBundleLanguage(String bundleLanguage)	Sets locale specific language of resource bundle; optional.
void	setBundleVariant(String bundleVariant)	Sets locale specific variant of resource bundle; optional.
void	setDestEncoding(String destEncoding)	Sets destination file encoding scheme; optional.
void	setEndToken(String endToken)	Sets ending token to identify keys; required.
void	setForceOverwrite(boolean forceOverwrite)	Whether or not to overwrite existing file irrespective of whether it is newer than the source file as well as the resource bundle file.
void	setSrcEncoding(String srcEncoding)	Sets source file encoding scheme; optional, defaults to encoding of local system.
void	setStartToken(String startToken)	Sets starting token to identify keys; required.
void	setToDir(File toDir)	Sets Destination directory; required.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Translate

public Translate()

Method Details

setBundle

public void setBundle(String bundle)

Sets Family name of resource bundle; required.

Parameters:

bundle - family name of resource bundle

setBundleLanguage

public void setBundleLanguage(String bundleLanguage)

Sets locale specific language of resource bundle; optional.

Parameters:

bundleLanguage - language of the bundle

setBundleCountry

public void setBundleCountry(String bundleCountry)

Sets locale specific country of resource bundle; optional.

Parameters:

bundleCountry - country of the bundle

setBundleVariant

public void setBundleVariant(String bundleVariant)

Sets locale specific variant of resource bundle; optional.

Parameters:

bundleVariant - locale variant of resource bundle

setToDir

public void setToDir(File toDir)

Sets Destination directory; required.

Parameters:

toDir - destination directory

setStartToken

public void setStartToken(String startToken)

Sets starting token to identify keys; required.

Parameters:

startToken - starting token to identify keys

setEndToken

public void setEndToken(String endToken)

Sets ending token to identify keys; required.

Parameters:

endToken - ending token to identify keys

setSrcEncoding

public void setSrcEncoding(String srcEncoding)

Sets source file encoding scheme; optional, defaults to encoding of local system.

Parameters:

srcEncoding - source file encoding

setDestEncoding

public void setDestEncoding(String destEncoding)

Sets destination file encoding scheme; optional. Defaults to source file encoding

Parameters:

destEncoding - destination file encoding scheme

setBundleEncoding

public void setBundleEncoding(String bundleEncoding)

Sets Resource Bundle file encoding scheme; optional. Defaults to source file encoding

Parameters:

bundleEncoding - bundle file encoding scheme

setForceOverwrite

public void setForceOverwrite(boolean forceOverwrite)

Whether or not to overwrite existing file irrespective of whether it is newer than the source file as well as the resource bundle file. Defaults to false.

Parameters:

forceOverwrite - whether or not to overwrite existing files

addFileset

public void addFileset(FileSet set)

Adds a set of files to translate as a nested fileset element.

Parameters:

set - the fileset to be added

execute

public void execute()
             throws BuildException

Check attributes values, load resource map and translate

Overrides:

execute in class Task

Throws:

BuildException - if the required attributes are not set Required :

• bundle
• starttoken
• endtoken