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- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description LoadProperties()
 - 
Method SummaryModifier 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.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Method Detail- 
setSrcFilepublic final void setSrcFile(java.io.File srcFile) Set the file to load.- Parameters:
- srcFile- The new SrcFile value
 
 - 
setResourcepublic void setResource(java.lang.String resource) Set the resource name of a property file to load.- Parameters:
- resource- resource on classpath
 
 - 
setEncodingpublic 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
 
 - 
setClasspathpublic void setClasspath(Path classpath) Set the classpath to use when looking up a resource.- Parameters:
- classpath- to add to any existing classpath
 
 - 
createClasspathpublic Path createClasspath() Add a classpath to use when looking up a resource.- Returns:
- The classpath to be configured
 
 - 
setClasspathRefpublic 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
 
 - 
getClasspathpublic Path getClasspath() get the classpath used by thisLoadProperties.- Returns:
- The classpath
 
 - 
setPrefixpublic void setPrefix(java.lang.String prefix) Set the prefix to load these properties under.- Parameters:
- prefix- to set
 
 - 
setPrefixValuespublic 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
 
 - 
executepublic final void execute() throws BuildExceptionload Ant properties from the source file or resource- Overrides:
- executein class- Task
- Throws:
- BuildException- if something goes wrong with the build
 
 - 
addFilterChainpublic final void addFilterChain(FilterChain filter) Adds a FilterChain.- Parameters:
- filter- the filter to add
 
 - 
addConfiguredpublic void addConfigured(ResourceCollection a) Set the source resource.- Parameters:
- a- the resource to load as a single element Resource collection.
- Since:
- Ant 1.7
 
 
- 
 
-