Apache Ant Core 1.10.14 · org.apache.tools.ant.types.Reference

Modifier and Type	Field and Description
private Project	project
private String	refid

Constructor Summary

Access	Constructor and Description
public	Reference() Deprecated since 1.7. Please use `Reference#Reference(Project, String)` instead. Create a reference.
public	Reference(String the name of this reference id) Deprecated since 1.7. Please use `Reference#Reference(Project, String)` instead. Create a reference to a named ID.
public	Reference(Project the project this reference is associated with p, String the name of this reference id) Create a reference to a named ID in a particular project.

Method Summary

Modifier and Type	Method and Description
public Project	Returns: the associated project getProject() Get the associated project, if any; may be null.
public < desired object type T> T	Returns: the dereferenced object. getReferencedObject(Project the fallback project to use if the project attribute of reference is not set. fallback) Resolve the reference, using the associated project if it set, otherwise use the passed in project.
public < desired object type T> T	Returns: the dereferenced object. getReferencedObject() Resolve the reference, looking in the associated project.
public String	Returns: the reference id getRefId() Get the reference id of this reference.
public void	setProject(Project the project to use p) Set the associated project.
public void	setRefId(String the reference id to use id) Set the reference id. Should not normally be necessary; use `Reference#Reference(Project, String)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

project	back to summary
private Project project

refid	back to summary
private String refid

Constructor Detail

Reference back to summary

Reference	back to summary
public Reference() Deprecated since 1.7. Please use `Reference#Reference(Project, String)` instead. Create a reference. Annotations @Deprecated

public Reference()

Deprecated

since 1.7. Please use Reference#Reference(Project, String) instead.

Create a reference.

Annotations

@Deprecated

Reference back to summary

Reference	back to summary
public Reference(String id) Deprecated since 1.7. Please use `Reference#Reference(Project, String)` instead. Create a reference to a named ID. Parameters id:String the name of this reference Annotations @Deprecated

public Reference(String id)

Deprecated

since 1.7. Please use Reference#Reference(Project, String) instead.

Create a reference to a named ID.

Parameters

id:String: the name of this reference

Annotations

@Deprecated

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

Reference

back to summary

public Reference(Project p, String id)

Create a reference to a named ID in a particular project.

Parameters

p:Project: the project this reference is associated with
id:String: the name of this reference

Since

Ant 1.6.3

Method Detail

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

getProject

back to summary

public Project getProject()

Get the associated project, if any; may be null.

Returns:Project: the associated project
Since: Ant 1.6.3

getReferencedObject	back to summary
public <T> T getReferencedObject(Project fallback) throws BuildException Resolve the reference, using the associated project if it set, otherwise use the passed in project. Parameters <T> desired object type fallback:Project the fallback project to use if the project attribute of reference is not set. Returns:T the dereferenced object. Exceptions BuildException: if the reference cannot be dereferenced.

getReferencedObject

back to summary

public <T> T getReferencedObject(Project fallback) throws BuildException

Resolve the reference, using the associated project if it set, otherwise use the passed in project.

Parameters

<T>: desired object type
fallback:Project: the fallback project to use if the project attribute of reference is not set.

Returns:T

the dereferenced object.

Exceptions

BuildException:: if the reference cannot be dereferenced.

getReferencedObject back to summary

getReferencedObject	back to summary
public <T> T getReferencedObject() throws BuildException Resolve the reference, looking in the associated project. Parameters <T> desired object type Returns:T the dereferenced object. Exceptions BuildException: if the project is null or the reference cannot be dereferenced Since Ant 1.6.3 See Also `Project#getReference`

public <T> T getReferencedObject() throws BuildException

Resolve the reference, looking in the associated project.

Parameters

<T>: desired object type

Returns:T

the dereferenced object.

Exceptions

BuildException:: if the project is null or the reference cannot be dereferenced

Since

Ant 1.6.3

See Also

Project#getReference

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

getRefId

back to summary

public String getRefId()

Get the reference id of this reference.

Returns:String: the reference id

setProject back to summary

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

public void setProject(Project p)

Set the associated project. Should not normally be necessary; use Reference#Reference(Project, String).

Parameters

p:Project: the project to use

Since

Ant 1.6.3

setRefId back to summary

setRefId	back to summary
public void setRefId(String id) Set the reference id. Should not normally be necessary; use `Reference#Reference(Project, String)`. Parameters id:String the reference id to use

public void setRefId(String id)

Set the reference id. Should not normally be necessary; use Reference#Reference(Project, String).

Parameters

id:String: the reference id to use

public Class Reference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail