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
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
filesetFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFileset(FileSet set) Adds a set of files to translate as a nested fileset element.voidexecute()Check attributes values, load resource map and translatevoidSets Family name of resource bundle; required.voidsetBundleCountry(String bundleCountry) Sets locale specific country of resource bundle; optional.voidsetBundleEncoding(String bundleEncoding) Sets Resource Bundle file encoding scheme; optional.voidsetBundleLanguage(String bundleLanguage) Sets locale specific language of resource bundle; optional.voidsetBundleVariant(String bundleVariant) Sets locale specific variant of resource bundle; optional.voidsetDestEncoding(String destEncoding) Sets destination file encoding scheme; optional.voidsetEndToken(String endToken) Sets ending token to identify keys; required.voidsetForceOverwrite(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.voidsetSrcEncoding(String srcEncoding) Sets source file encoding scheme; optional, defaults to encoding of local system.voidsetStartToken(String startToken) Sets starting token to identify keys; required.voidSets 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, XsetItemsMethods 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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation
-
Constructor Details
-
Translate
public Translate()
-
-
Method Details
-
setBundle
Sets Family name of resource bundle; required.- Parameters:
bundle- family name of resource bundle
-
setBundleLanguage
Sets locale specific language of resource bundle; optional.- Parameters:
bundleLanguage- language of the bundle
-
setBundleCountry
Sets locale specific country of resource bundle; optional.- Parameters:
bundleCountry- country of the bundle
-
setBundleVariant
Sets locale specific variant of resource bundle; optional.- Parameters:
bundleVariant- locale variant of resource bundle
-
setToDir
Sets Destination directory; required.- Parameters:
toDir- destination directory
-
setStartToken
Sets starting token to identify keys; required.- Parameters:
startToken- starting token to identify keys
-
setEndToken
Sets ending token to identify keys; required.- Parameters:
endToken- ending token to identify keys
-
setSrcEncoding
Sets source file encoding scheme; optional, defaults to encoding of local system.- Parameters:
srcEncoding- source file encoding
-
setDestEncoding
Sets destination file encoding scheme; optional. Defaults to source file encoding- Parameters:
destEncoding- destination file encoding scheme
-
setBundleEncoding
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
Adds a set of files to translate as a nested fileset element.- Parameters:
set- the fileset to be added
-
execute
Check attributes values, load resource map and translate- Overrides:
executein classTask- Throws:
BuildException- if the required attributes are not set Required :- bundle
- starttoken
- endtoken
-