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:
Cloneable
public class LoadProperties extends Task
Load a file's contents as Ant properties.
Since:
Ant 1.5

  • Constructor Details

    • LoadProperties

      public LoadProperties()

  • Method Details

    • setSrcFile

      public final void setSrcFile(File srcFile)
      Set the file to load.
      Parameters:
      srcFile - The new SrcFile value

    • setResource

      public void setResource(String resource)
      Set the resource name of a property file to load.
      Parameters:
      resource - resource on classpath

    • 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 https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html .

      Parameters:
      encoding - The new Encoding value

    • setClasspath

      public void setClasspath(Path classpath)
      Set the classpath to use when looking up a resource.
      Parameters:
      classpath - to add to any existing classpath

    • createClasspath

      public Path createClasspath()
      Add a classpath to use when looking up a resource.
      Returns:
      The classpath to be configured

    • 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

    • getClasspath

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

    • 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.
      Parameters:
      b - boolean
      Since:
      Ant 1.8.2

    • execute

      public final void execute() throws BuildException
      load Ant properties from the source file or resource
      Overrides:
      execute in class Task
      Throws:
      BuildException - if something goes wrong with the build

    • addFilterChain

      public final void addFilterChain(FilterChain filter)
      Adds a FilterChain.
      Parameters:
      filter - the filter to add

    • 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