org.apache.tools.ant.types.optional

Class ScriptMapper

public class ScriptMapper extends AbstractScriptComponent implements FileNameMapper

Script support at map time.

Since: Ant1.7

Method Summary
voidaddMappedName(String mapping)
Add a mapped name
voidclear()
Reset the list of files
String[]mapFileName(String sourceFileName)
Returns an array containing the target filename(s) for the given source file.
voidsetFrom(String from)
Sets the from part of the transformation rule.
voidsetTo(String to)
Sets the to part of the transformation rule.

Method Detail

addMappedName

public void addMappedName(String mapping)
Add a mapped name

Parameters: mapping the value to use.

clear

public void clear()
Reset the list of files

mapFileName

public String[] mapFileName(String sourceFileName)
Returns an array containing the target filename(s) for the given source file.

if the given rule doesn't apply to the source file, implementation must return null. SourceFileScanner will then omit the source file in question.

Parameters: sourceFileName the name of the source file relative to some given basedirectory.

Returns: an array of strings if the rule applies to the source file, or null if it does not.

setFrom

public void setFrom(String from)
Sets the from part of the transformation rule.

Parameters: from a string.

setTo

public void setTo(String to)
Sets the to part of the transformation rule.

Parameters: to a string.