|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tools.ant.ProjectComponent org.apache.tools.ant.Task org.apache.tools.ant.taskdefs.Property
public class Property
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 five ways to set properties:
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.
Field Summary | |
---|---|
protected Path |
classpath
|
protected java.lang.String |
env
|
protected java.io.File |
file
|
protected java.lang.String |
name
|
protected java.lang.String |
prefix
|
protected Reference |
ref
|
protected java.lang.String |
resource
|
protected java.net.URL |
url
|
protected boolean |
userProperty
|
protected java.lang.String |
value
|
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 |
Constructor Summary | |
---|---|
|
Property()
Constructor for Property. |
protected |
Property(boolean userProperty)
Constructor for Property. |
protected |
Property(boolean userProperty,
Project fallback)
Constructor for Property. |
Method Summary | |
---|---|
protected void |
addProperties(java.util.Properties props)
iterate through a set of properties, resolve them then assign them |
protected void |
addProperty(java.lang.String n,
java.lang.String v)
add a name value pair to the project property set |
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. |
java.lang.String |
getEnvironment()
Get the environment attribute. |
java.io.File |
getFile()
Get the file attribute. |
java.lang.String |
getName()
Get the property name. |
java.lang.String |
getPrefix()
Get the prefix attribute. |
Reference |
getRefid()
Get the refid attribute. |
java.lang.String |
getResource()
Get the resource attribute. |
java.net.URL |
getUrl()
Get the url attribute. |
java.lang.String |
getValue()
Get the property value. |
protected void |
loadEnvironment(java.lang.String prefix)
load the environment values |
protected void |
loadFile(java.io.File file)
load properties from a file |
protected void |
loadResource(java.lang.String name)
load properties from a resource in the current classpath |
protected void |
loadUrl(java.net.URL url)
load properties from a url |
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(java.lang.String env)
Prefix to use when retrieving environment variables. |
void |
setFile(java.io.File file)
Filename of a property file to load. |
void |
setLocation(java.io.File location)
Sets the property to the absolute filename of the given file. |
void |
setName(java.lang.String name)
The name of the property to set. |
void |
setPrefix(java.lang.String prefix)
Prefix to apply to properties loaded using file
or resource . |
void |
setRefid(Reference ref)
Sets a reference to an Ant datatype declared elsewhere. |
void |
setResource(java.lang.String resource)
The resource name of a property file to load |
void |
setUrl(java.net.URL url)
The url from which to load properties. |
void |
setUserProperty(boolean userProperty)
Deprecated. since 1.5.x. This was never a supported feature and has been deprecated without replacement. |
void |
setValue(java.lang.String value)
The value of the property. |
java.lang.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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String name
protected java.lang.String value
protected java.io.File file
protected java.net.URL url
protected java.lang.String resource
protected Path classpath
protected java.lang.String env
protected Reference ref
protected java.lang.String prefix
protected boolean userProperty
Constructor Detail |
---|
public Property()
protected Property(boolean userProperty)
userProperty
- if true this is a user propertyprotected Property(boolean userProperty, Project fallback)
userProperty
- if true this is a user propertyfallback
- a project to use to look for references if the reference is
not in the current projectMethod Detail |
---|
public void setName(java.lang.String name)
name
- property namepublic java.lang.String getName()
public void setLocation(java.io.File location)
location
- path to setpublic void setValue(java.lang.String value)
value
- value to assignpublic java.lang.String getValue()
public void setFile(java.io.File file)
file
- filenamepublic java.io.File getFile()
public void setUrl(java.net.URL url)
url
- url stringpublic java.net.URL getUrl()
public void setPrefix(java.lang.String prefix)
file
or resource
.
A "." is appended to the prefix if not specified.
prefix
- prefix stringpublic java.lang.String getPrefix()
public void setRefid(Reference ref)
ref
- referencepublic Reference getRefid()
public void setResource(java.lang.String resource)
resource
- resource on classpathpublic java.lang.String getResource()
public void setEnvironment(java.lang.String env)
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.
env
- prefixpublic java.lang.String getEnvironment()
public void setClasspath(Path classpath)
classpath
- to add to any existing classpathpublic Path createClasspath()
public void setClasspathRef(Reference r)
r
- a reference to a classpathpublic Path getClasspath()
public void setUserProperty(boolean userProperty)
userProperty
- ignoredpublic java.lang.String toString()
toString
in class java.lang.Object
public void execute() throws BuildException
execute
in class Task
BuildException
- on errorprotected void loadUrl(java.net.URL url) throws BuildException
url
- url to load from
BuildException
- on errorprotected void loadFile(java.io.File file) throws BuildException
file
- file to load
BuildException
- on errorprotected void loadResource(java.lang.String name)
name
- name of resource to loadprotected void loadEnvironment(java.lang.String prefix)
prefix
- prefix to place before themprotected void addProperties(java.util.Properties props)
props
- the properties to iterate overprotected void addProperty(java.lang.String n, java.lang.String v)
n
- name of propertyv
- value to set
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |