org.apache.tools.ant.types

Class Reference

Known Direct Subclasses:
Ant.Reference

public class Reference
extends java.lang.Object

Class to hold a reference to another object in the project.

Constructor Summary

Reference()
Deprecated. Please use Reference(Project,String) instead.
Reference(String id)
Deprecated. Please use Reference(Project,String) instead.
Reference(Project p, String id)
Create a reference to a named ID in a particular project.

Method Summary

Project
getProject()
Get the associated project, if any; may be null.
String
getRefId()
Get the reference id of this reference.
Object
getReferencedObject()
Resolve the reference, looking in the associated project.
Object
getReferencedObject(Project fallback)
Resolve the reference, using the associated project if it set, otherwise use the passed in project.
void
setProject(Project p)
Set the associated project.
void
setRefId(String id)
Set the reference id.

Constructor Details

Reference

public Reference()

Deprecated. Please use Reference(Project,String) instead.

Create a reference.

Reference

public Reference(String id)

Deprecated. Please use Reference(Project,String) instead.

Create a reference to a named ID.
Parameters:
id - the name of this reference

Reference

public Reference(Project p,
                 String id)
Create a reference to a named ID in a particular project.
Parameters:
p - the project this reference is associated with
id - the name of this reference
Since:
Ant 1.6.3

Method Details

getProject

public Project getProject()
Get the associated project, if any; may be null.
Returns:
the associated project
Since:
Ant 1.6.3

getRefId

public String getRefId()
Get the reference id of this reference.
Returns:
the reference id

getReferencedObject

public Object getReferencedObject()
            throws BuildException
Resolve the reference, looking in the associated project.
Returns:
the dereferenced object.
Throws:
BuildException - if the project is null or the reference cannot be dereferenced
Since:
Ant 1.6.3

getReferencedObject

public Object getReferencedObject(Project fallback)
            throws BuildException
Resolve the reference, using the associated project if it set, otherwise use the passed in project.
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.

setProject

public void setProject(Project p)
Set the associated project. Should not normally be necessary; use Reference(Project,String).
Parameters:
p - the project to use
Since:
Ant 1.6.3

setRefId

public void setRefId(String id)
Parameters:
id - the reference id to use

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.