Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs

Class LoadProperties

Implemented Interfaces:
Cloneable
public class LoadProperties
extends Task
Load a file's contents as Ant properties.
Since:
Ant 1.5

Field Summary

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

Method Summary

void
addConfigured(ResourceCollection a)
Set the source resource.
void
addFilterChain(FilterChain filter)
Adds a FilterChain.
Path
createClasspath()
Add a classpath to use when looking up a resource.
void
execute()
load Ant properties from the source file or resource
Path
getClasspath()
get the classpath used by this LoadProperties.
void
setClasspath(Path classpath)
Set the classpath to use when looking up a resource.
void
setClasspathRef(Reference r)
Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
void
setEncoding(String encoding)
Encoding to use for input, defaults to the platform's default encoding.
void
setResource(String resource)
Set the resource name of a property file to load.
void
setSrcFile(File srcFile)
Set the file to load.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, 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, log, log, setDescription, setLocation, setProject

Method Details

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()
            throws BuildException
load Ant properties from the source file or resource
Overrides:
execute in interface Task
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

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

Overview Package Tree Index Deprecated About