Package org.apache.tools.ant.types
Class Reference
java.lang.Object
org.apache.tools.ant.types.Reference
- Direct Known Subclasses:
Ant.Reference
Class to hold a reference to another object in the project.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the associated project, if any; may be null.<T> T
Resolve the reference, looking in the associated project.<T> T
getReferencedObject
(Project fallback) Resolve the reference, using the associated project if it set, otherwise use the passed in project.getRefId()
Get the reference id of this reference.void
Set the associated project.void
Set the reference id.
-
Constructor Details
-
Reference
Deprecated.since 1.7. Please useReference(Project,String)
instead.Create a reference. -
Reference
Deprecated.since 1.7. Please useReference(Project,String)
instead.Create a reference to a named ID.- Parameters:
id
- the name of this reference
-
Reference
Create a reference to a named ID in a particular project.- Parameters:
p
- the project this reference is associated withid
- the name of this reference- Since:
- Ant 1.6.3
-
-
Method Details
-
setRefId
Set the reference id. Should not normally be necessary; useReference(Project, String)
.- Parameters:
id
- the reference id to use
-
getRefId
Get the reference id of this reference.- Returns:
- the reference id
-
setProject
Set the associated project. Should not normally be necessary; useReference(Project,String)
.- Parameters:
p
- the project to use- Since:
- Ant 1.6.3
-
getProject
Get the associated project, if any; may be null.- Returns:
- the associated project
- Since:
- Ant 1.6.3
-
getReferencedObject
Resolve the reference, using the associated project if it set, otherwise use the passed in project.- Type Parameters:
T
- desired object type- Parameters:
fallback
- the fallback project to use if the project attribute of reference is not set.- Returns:
- the dereferenced object.
- Throws:
BuildException
- if the reference cannot be dereferenced.
-
getReferencedObject
Resolve the reference, looking in the associated project.- Type Parameters:
T
- desired object type- Returns:
- the dereferenced object.
- Throws:
BuildException
- if the project is null or the reference cannot be dereferenced- Since:
- Ant 1.6.3
- See Also:
-