Package org.apache.tools.ant.taskdefs
Class LoadProperties
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.LoadProperties
- All Implemented Interfaces:
java.lang.Cloneable
public class LoadProperties extends Task
Load a file's contents as Ant properties.
- Since:
- Ant 1.5
-
Field Summary
-
Constructor Summary
Constructors Constructor Description LoadProperties() -
Method Summary
Modifier and Type Method Description 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 resourcePathgetClasspath()get the classpath used by thisLoadProperties.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 elsewherevoidsetEncoding(java.lang.String encoding)Encoding to use for input, defaults to the platform's default encoding.voidsetPrefix(java.lang.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(java.lang.String resource)Set the resource name of a property file to load.voidsetSrcFile(java.io.File srcFile)Set the file to load.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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
LoadProperties
public LoadProperties()
-
-
Method Details
-
setSrcFile
public final void setSrcFile(java.io.File srcFile)Set the file to load.- Parameters:
srcFile- The new SrcFile value
-
setResource
public void setResource(java.lang.String resource)Set the resource name of a property file to load.- Parameters:
resource- resource on classpath
-
setEncoding
public final void setEncoding(java.lang.String encoding)Encoding to use for input, defaults to the platform's default encoding.For a list of possible values see https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html .
- Parameters:
encoding- The new Encoding value
-
setClasspath
Set the classpath to use when looking up a resource.- Parameters:
classpath- to add to any existing classpath
-
createClasspath
Add a classpath to use when looking up a resource.- Returns:
- The classpath to be configured
-
setClasspathRef
Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere- Parameters:
r- The reference value
-
getClasspath
get the classpath used by thisLoadProperties.- Returns:
- The classpath
-
setPrefix
public void setPrefix(java.lang.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.- Parameters:
b- boolean- Since:
- Ant 1.8.2
-
execute
load Ant properties from the source file or resource- Overrides:
executein classTask- Throws:
BuildException- if something goes wrong with the build
-
addFilterChain
Adds a FilterChain.- Parameters:
filter- the filter to add
-
addConfigured
Set the source resource.- Parameters:
a- the resource to load as a single element Resource collection.- Since:
- Ant 1.7
-