peterreilly 2005/01/13 05:50:38
Modified: src/main/org/apache/tools/ant/types Reference.java
Log:
javadoc + trailing spaces
Revision Changes Path
1.20 +16 -5 ant/src/main/org/apache/tools/ant/types/Reference.java
Index: Reference.java
===================================================================
RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/Reference.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- Reference.java 13 Jan 2005 13:43:45 -0000 1.19
+++ Reference.java 13 Jan 2005 13:50:38 -0000 1.20
@@ -30,18 +30,21 @@
private Project project;
/**
+ * Create a reference.
* @deprecated Please use [EMAIL PROTECTED]
Reference#Reference(Project,String)} instead.
*/
public Reference() {
}
/**
+ * Create a reference to a named ID.
+ * @param id the name of this reference
* @deprecated Please use [EMAIL PROTECTED]
Reference#Reference(Project,String)} instead.
*/
public Reference(String id) {
setRefId(id);
}
-
+
/**
* Create a reference to a named ID in a particular project.
* @param p the project this reference is associated with
@@ -53,14 +56,23 @@
setProject(p);
}
+ /**
+ * Set the reference id. Should not normally be necessary;
+ * use [EMAIL PROTECTED] Reference#Reference(Project, String)}.
+ * @param id the reference id to use
+ */
public void setRefId(String id) {
refid = id;
}
+ /**
+ * Get the reference id of this reference.
+ * @return the reference id
+ */
public String getRefId() {
return refid;
}
-
+
/**
* Set the associated project. Should not normally be necessary;
* use [EMAIL PROTECTED] Reference#Reference(Project,String)}.
@@ -70,7 +82,7 @@
public void setProject(Project p) {
this.project = p;
}
-
+
/**
* Get the associated project, if any; may be null.
* @return the associated project
@@ -93,14 +105,13 @@
throw new BuildException("No reference specified");
}
-
Object o = project == null ? fallback.getReference(refid) :
project.getReference(refid);
if (o == null) {
throw new BuildException("Reference " + refid + " not found.");
}
return o;
}
-
+
/**
* Resolve the reference, looking in the associated project.
* @see Project#getReference
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
