rdonkin 2003/01/11 01:14:01
Modified: betwixt/src/java/org/apache/commons/betwixt/expression
StringExpression.java VariableExpression.java
Log:
Improved java docs
Revision Changes Path
1.4 +13 -2
jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/expression/StringExpression.java
Index: StringExpression.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/expression/StringExpression.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- StringExpression.java 5 Jan 2003 17:18:32 -0000 1.3
+++ StringExpression.java 11 Jan 2003 09:14:01 -0000 1.4
@@ -71,12 +71,15 @@
/** We only need only <code>StringExpression</code> */
private static final StringExpression singleton = new StringExpression();
- /** Get the singleton */
+ /**
+ * Gets the singleton
+ * @return the singleton <code>StringExpression</code> instance
+ */
public static StringExpression getInstance() {
return singleton;
}
- /** Should this be private? */
+ /** Base constructor. Should this be private? */
public StringExpression() {
}
@@ -93,10 +96,18 @@
return null;
}
+ /**
+ * Do nothing
+ * @see org.apache.commons.betwixt.expression.Expression
+ */
public void update(Context context, String newValue) {
// do nothing
}
+ /**
+ * Returns something useful for logging.
+ * @return the (short) class name
+ */
public String toString() {
return "StringExpression";
}
1.3 +22 -3
jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/expression/VariableExpression.java
Index: VariableExpression.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/expression/VariableExpression.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- VariableExpression.java 1 Jul 2002 18:58:53 -0000 1.2
+++ VariableExpression.java 11 Jan 2003 09:14:01 -0000 1.3
@@ -76,7 +76,11 @@
public VariableExpression() {
}
- /** Convenience constructor sets <code>VariableName</code> property */
+ /**
+ * Convenience constructor sets <code>VariableName</code> property
+ * @param variableName the name of the context variable
+ * whose value will be returned by an evaluation
+ */
public VariableExpression(String variableName) {
this.variableName = variableName;
}
@@ -90,20 +94,35 @@
return context.getVariable( variableName );
}
- /** Gets the variable name */
+ /**
+ * Gets the variable name
+ * @return the name of the context variable whose value will be returned by an
evaluation
+ */
public String getVariableName() {
return variableName;
}
- /** Sets the variable name */
+ /**
+ * Sets the variable name
+ * @param variableName the name of the context variable
+ * whose value will be returned by an evaluation
+ */
public void setVariableName(String variableName) {
this.variableName = variableName;
}
+ /**
+ * Do nothing
+ * @see org.apache.commons.betwixt.expression.Expression
+ */
public void update(Context context, String newValue) {
// do nothing
}
+ /**
+ * Returns something useful for logging
+ * @return something useful for logging
+ */
public String toString() {
return "VariableExpression [variable name=" + variableName + "]";
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
