Property

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - org.apache.tools.ant.taskdefs.Property

All Implemented Interfaces:

Cloneable
```
public class Property
extends Task
```
Sets a property by name, or set of properties (from file or resource) in the project.

Properties are immutable: whoever sets a property first freezes it for the rest of the build; they are most definitely not variable.
There are seven ways to set properties:
- By supplying both the name and value attribute.
- By supplying the name and nested text.
- By supplying both the name and refid attribute.
- By setting the file attribute with the filename of the property file to load. This property file has the format as defined by the file used in the class java.util.Properties.
- By setting the url attribute with the url from which to load the properties. This url must be directed to a file that has the format as defined by the file used in the class java.util.Properties.
- By setting the resource attribute with the resource name of the property file to load. This property file has the format as defined by the file used in the class java.util.Properties.
- By setting the environment attribute with a prefix to use. Properties will be defined for every environment variable by prefixing the supplied name and a period to the name of the variable.
Although combinations of these ways are possible, only one should be used at a time. Problems might occur with the order in which properties are set, for instance.

The value part of the properties being set, might contain references to other properties. These references are resolved at the time these properties are set. This also holds for properties loaded from a property file.
Properties are case sensitive.
Since:

Ant 1.1

Field Summary

Fields
Modifier and Type	Field and Description
`protected Path`	`classpath`
`protected String`	`env`
`protected File`	`file`
`protected String`	`name`
`protected String`	`prefix`
`protected Reference`	`ref`
`protected String`	`resource`
`protected URL`	`url`
`protected boolean`	`userProperty`
`protected String`	`value`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Property()` Constructor for Property.
`protected`	`Property(boolean userProperty)` Constructor for Property.
`protected`	`Property(boolean userProperty, Project fallback)` Constructor for Property.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addProperties(Properties props)` iterate through a set of properties, resolve them then assign them
`protected void`	`addProperty(String n, Object v)` add a name value pair to the project property set
`protected void`	`addProperty(String n, String v)` add a name value pair to the project property set
`void`	`addText(String msg)` Set a (multiline) property as nested text.
`Path`	`createClasspath()` The classpath to use when looking up a resource.
`void`	`execute()` set the property in the project to the value.
`Path`	`getClasspath()` Get the classpath used when looking up a resource.
`String`	`getEnvironment()` Get the environment attribute.
`File`	`getFile()` Get the file attribute.
`String`	`getName()` Get the property name.
`String`	`getPrefix()` Get the prefix attribute.
`boolean`	`getPrefixValues()` Whether to apply the prefix when expanding properties on the right hand side of a properties file as well.
`Reference`	`getRefid()` Get the refid attribute.
`String`	`getResource()` Get the resource attribute.
`URL`	`getUrl()` Get the url attribute.
`String`	`getValue()` Get the property value.
`protected void`	`loadEnvironment(String prefix)` load the environment values
`protected void`	`loadFile(File file)` load properties from a file
`protected void`	`loadResource(String name)` load properties from a resource in the current classpath
`protected void`	`loadUrl(URL url)` load properties from a url
`void`	`setBasedir(File basedir)` Sets 'basedir' attribute.
`void`	`setClasspath(Path classpath)` The classpath to use when looking up a resource.
`void`	`setClasspathRef(Reference r)` the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
`void`	`setEnvironment(String env)` Prefix to use when retrieving environment variables.
`void`	`setFile(File file)` Filename of a property file to load.
`void`	`setLocation(File location)` Sets the property to the absolute filename of the given file.
`void`	`setName(String name)` The name of the property to set.
`void`	`setPrefix(String prefix)` Prefix to apply to properties loaded using `file` or `resource`.
`void`	`setPrefixValues(boolean b)` Whether to apply the prefix when expanding properties on the right hand side of a properties file as well.
`void`	`setRefid(Reference ref)` Sets a reference to an Ant datatype declared elsewhere.
`void`	`setRelative(boolean relative)` Sets 'relative' attribute.
`void`	`setResource(String resource)` The resource name of a property file to load
`void`	`setUrl(URL url)` The url from which to load properties.
`void`	`setValue(Object value)` Set the value of the property.
`void`	`setValue(String value)` Set the value of the property as a String.
`String`	`toString()` get the value of this property

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, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - classpath
```
protected Path classpath
```
  - env
```
protected String env
```
  - file
```
protected File file
```
  - name
```
protected String name
```
  - prefix
```
protected String prefix
```
  - ref
```
protected Reference ref
```
  - resource
```
protected String resource
```
  - url
```
protected URL url
```
  - userProperty
```
protected boolean userProperty
```
  - value
```
protected String value
```
- Constructor Detail
  - Property
```
public Property()
```
    Constructor for Property.
  - Property
```
protected Property(boolean userProperty)
```
    Constructor for Property.
    
    Parameters:
    
    userProperty - if true this is a user property
    
    Since:
    
    Ant 1.5
  - Property
```
protected Property(boolean userProperty,
                   Project fallback)
```
    Constructor for Property.
    
    Parameters:
    
    userProperty - if true this is a user property
    
    fallback - a project to use to look for references if the reference is not in the current project
    
    Since:
    
    Ant 1.5
- Method Detail
  - addProperties
```
protected void addProperties(Properties props)
```
    iterate through a set of properties, resolve them then assign them
    
    Parameters:
    
    props - the properties to iterate over
  - addProperty
```
protected void addProperty(String n,
                           Object v)
```
    add a name value pair to the project property set
    
    Parameters:
    
    n - name of property
    
    v - value to set
    
    Since:
    
    Ant 1.8
  - addProperty
```
protected void addProperty(String n,
                           String v)
```
    add a name value pair to the project property set
    
    Parameters:
    
    n - name of property
    
    v - value to set
  - addText
```
public void addText(String msg)
```
    Set a (multiline) property as nested text.
    
    Parameters:
    
    msg - the text to append to the output text
    
    Since:
    
    Ant 1.8.0
  - createClasspath
```
public Path createClasspath()
```
    The classpath to use when looking up a resource.
    
    Returns:
    
    a path to be configured
  - execute
```
public void execute()
             throws BuildException
```
    set the property in the project to the value. if the task was give a file, resource or env attribute here is where it is loaded
    
    Overrides:
    
    execute in class Task
    
    Throws:
    
    BuildException - on error
  - getClasspath
```
public Path getClasspath()
```
    Get the classpath used when looking up a resource.
    
    Returns:
    
    the classpath
    
    Since:
    
    Ant 1.5
  - getEnvironment
```
public String getEnvironment()
```
    Get the environment attribute.
    
    Returns:
    
    the environment attribute
    
    Since:
    
    Ant 1.5
  - getFile
```
public File getFile()
```
    Get the file attribute.
    
    Returns:
    
    the file attribute
  - getName
```
public String getName()
```
    Get the property name.
    
    Returns:
    
    the property name
  - getPrefix
```
public String getPrefix()
```
    Get the prefix attribute.
    
    Returns:
    
    the prefix attribute
    
    Since:
    
    Ant 1.5
  - getPrefixValues
```
public boolean getPrefixValues()
```
    Whether to apply the prefix when expanding properties on the right hand side of a properties file as well.
    
    Since:
    
    Ant 1.8.2
  - getRefid
```
public Reference getRefid()
```
    Get the refid attribute.
    
    Returns:
    
    the refid attribute
  - getResource
```
public String getResource()
```
    Get the resource attribute.
    
    Returns:
    
    the resource attribute
  - getUrl
```
public URL getUrl()
```
    Get the url attribute.
    
    Returns:
    
    the url attribute
  - getValue
```
public String getValue()
```
    Get the property value.
    
    Returns:
    
    the property value
  - loadEnvironment
```
protected void loadEnvironment(String prefix)
```
    load the environment values
    
    Parameters:
    
    prefix - prefix to place before them
  - loadFile
```
protected void loadFile(File file)
                 throws BuildException
```
    load properties from a file
    
    Parameters:
    
    file - file to load
    
    Throws:
    
    BuildException - on error
  - loadResource
```
protected void loadResource(String name)
```
    load properties from a resource in the current classpath
    
    Parameters:
    
    name - name of resource to load
  - loadUrl
```
protected void loadUrl(URL url)
                throws BuildException
```
    load properties from a url
    
    Parameters:
    
    url - url to load from
    
    Throws:
    
    BuildException - on error
  - setBasedir
```
public void setBasedir(File basedir)
```
    Sets 'basedir' attribute.
    
    Parameters:
    
    basedir - new value
    
    Since:
    
    Ant 1.8.0
  - setClasspath
```
public void setClasspath(Path classpath)
```
    The classpath to use when looking up a resource.
    
    Parameters:
    
    classpath - to add to any existing classpath
  - setClasspathRef
```
public void setClasspathRef(Reference r)
```
    the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
    
    Parameters:
    
    r - a reference to a classpath
  - setEnvironment
```
public void setEnvironment(String env)
```
    Prefix to use when retrieving environment variables. Thus if you specify environment="myenv" you will be able to access OS-specific environment variables via property names "myenv.PATH" or "myenv.TERM".
    Note that if you supply a property name with a final "." it will not be doubled. ie environment="myenv." will still allow access of environment variables through "myenv.PATH" and "myenv.TERM". This functionality is currently only implemented on select platforms. Feel free to send patches to increase the number of platforms this functionality is supported on ;).
    Note also that properties are case sensitive, even if the environment variables on your operating system are not, e.g. it will be ${env.Path} not ${env.PATH} on Windows 2000.
    
    Parameters:
    
    env - prefix
  - setFile
```
public void setFile(File file)
```
    Filename of a property file to load.
    
    Parameters:
    
    file - filename
  - setLocation
```
public void setLocation(File location)
```
    Sets the property to the absolute filename of the given file. If the value of this attribute is an absolute path, it is left unchanged (with / and \ characters converted to the current platforms conventions). Otherwise it is taken as a path relative to the project's basedir and expanded.
    
    Parameters:
    
    location - path to set
  - setName
```
public void setName(String name)
```
    The name of the property to set.
    
    Parameters:
    
    name - property name
  - setPrefix
```
public void setPrefix(String prefix)
```
    Prefix to apply to properties loaded using file or resource. A "." is appended to the prefix if not specified.
    
    Parameters:
    
    prefix - prefix string
    
    Since:
    
    Ant 1.5
  - 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
  - setRefid
```
public void setRefid(Reference ref)
```
    Sets a reference to an Ant datatype declared elsewhere. Only yields reasonable results for references PATH like structures or properties.
    
    Parameters:
    
    ref - reference
  - setRelative
```
public void setRelative(boolean relative)
```
    Sets 'relative' attribute.
    
    Parameters:
    
    relative - new value
    
    Since:
    
    Ant 1.8.0
  - setResource
```
public void setResource(String resource)
```
    The resource name of a property file to load
    
    Parameters:
    
    resource - resource on classpath
  - setUrl
```
public void setUrl(URL url)
```
    The url from which to load properties.
    
    Parameters:
    
    url - url string
  - setValue
```
public void setValue(Object value)
```
    Set the value of the property.
    
    Parameters:
    
    value - the value to use.
  - setValue
```
public void setValue(String value)
```
    Set the value of the property as a String.
    
    Parameters:
    
    value - value to assign
  - toString
```
public String toString()
```
    get the value of this property
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the current value or the empty string

Class Property

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

classpath

env

file

name

prefix

ref

resource

url

userProperty

value

Constructor Detail

Property

Property

Property

Method Detail

addProperties

addProperty

addProperty

addText

createClasspath

execute

getClasspath

getEnvironment

getFile

getName

getPrefix

getPrefixValues

getRefid

getResource

getUrl

getValue

loadEnvironment

loadFile

loadResource

loadUrl

setBasedir

setClasspath

setClasspathRef

setEnvironment

setFile

setLocation

setName

setPrefix

setPrefixValues

setRefid

setRelative

setResource

setUrl

setValue

setValue

toString