org.apache.tools.ant.taskdefs

Class LoadProperties

public class LoadProperties extends Task

Load a file's contents as Ant properties.

Since: Ant 1.5

UNKNOWN: category="utility"

Method Summary
voidaddConfigured(ResourceCollection a)
Set the source resource.
voidaddFilterChain(FilterChain filter)
Adds a FilterChain.
PathcreateClasspath()
Add a classpath to use when looking up a resource.
voidexecute()
load Ant properties from the source file or resource
PathgetClasspath()
get the classpath used by this LoadProperties.
voidsetClasspath(Path classpath)
Set the classpath to use when looking up a resource.
voidsetClasspathRef(Reference r)
Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
voidsetEncoding(String encoding)
Encoding to use for input, defaults to the platform's default encoding.
voidsetPrefix(String prefix)
Set the prefix to load these properties under.
voidsetPrefixValues(boolean b)
Whether to apply the prefix when expanding properties on the right hand side of a properties file as well.
voidsetResource(String resource)
Set the resource name of a property file to load.
voidsetSrcFile(File srcFile)
Set the file to load.

Method Detail

addConfigured

public void addConfigured(ResourceCollection a)
Set the source resource.

Parameters: a the resource to load as a single element Resource collection.

Since: Ant 1.7

addFilterChain

public final void addFilterChain(FilterChain filter)
Adds a FilterChain.

Parameters: filter the filter to add

createClasspath

public Path createClasspath()
Add a classpath to use when looking up a resource.

Returns: The classpath to be configured

execute

public final void execute()
load Ant properties from the source file or resource

Throws: BuildException if something goes wrong with the build

getClasspath

public Path getClasspath()
get the classpath used by this LoadProperties.

Returns: The classpath

setClasspath

public void setClasspath(Path classpath)
Set the classpath to use when looking up a resource.

Parameters: classpath to add to any existing classpath

setClasspathRef

public void setClasspathRef(Reference r)
Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere

Parameters: r The reference value

setEncoding

public final void setEncoding(String encoding)
Encoding to use for input, defaults to the platform's default encoding.

For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html .

Parameters: encoding The new Encoding value

setPrefix

public void setPrefix(String prefix)
Set the prefix to load these properties under.

Parameters: prefix to set

setPrefixValues

public void setPrefixValues(boolean b)
Whether to apply the prefix when expanding properties on the right hand side of a properties file as well.

Since: Ant 1.8.2

setResource

public void setResource(String resource)
Set the resource name of a property file to load.

Parameters: resource resource on classpath

setSrcFile

public final void setSrcFile(File srcFile)
Set the file to load.

Parameters: srcFile The new SrcFile value