Author: ruschein
Date: 2010-10-18 11:58:30 -0700 (Mon, 18 Oct 2010)
New Revision: 22273
Modified:
core3/work-api/trunk/src/main/java/org/cytoscape/work/util/AbstractBounded.java
Log:
Updated Javadoc.
Modified:
core3/work-api/trunk/src/main/java/org/cytoscape/work/util/AbstractBounded.java
===================================================================
---
core3/work-api/trunk/src/main/java/org/cytoscape/work/util/AbstractBounded.java
2010-10-18 18:06:30 UTC (rev 22272)
+++
core3/work-api/trunk/src/main/java/org/cytoscape/work/util/AbstractBounded.java
2010-10-18 18:58:30 UTC (rev 22273)
@@ -35,45 +35,45 @@
*/
public abstract class AbstractBounded<N extends Comparable<N>> {
/**
- * Initial Value of the Bounded Object that will be modified
+ * Initial value of the Bounded Object that will be modified
*/
private N value;
-
+
/**
- * Value of the lower bound of the Bounded Object
+ * Value of the lower bound of the Bounded Object
*/
private final N lower;
-
+
/**
- * Value of the upper bound of the Bounded Object
+ * Value of the upper bound of the Bounded Object
*/
private final N upper;
-
+
/**
- * Whether or not the <code>value</code> could be set to the
<code>upper</code> value
- *
- * <p><pre>
- * <code> if(upperstrict==true)</code> , then the <code>value</code>
cannot be set to <code>upper</code>
+ * Whether or not the <code>value</code> could be set to the
<code>upper</code> value
+ *
+ * <p><pre>
+ * <code> if (upperStrict)</code> , then the <code>value</code>
cannot be set to <code>upper</code>
* </pre></p>
*/
private final boolean upperStrict;
-
+
/**
- * Whether or not the <code>value</code> could be set to the
<code>lower</code> value
- *
- * <p><pre>
- * <code> if(lowerstrict==true)</code> , then the <code>value</code>
cannot be set to <code>lower</code>
+ * Whether or not the <code>value</code> could be set to the
<code>lower</code> value
+ *
+ * <p><pre>
+ * <code> if (lowerStrict)</code> , then the <code>value</code>
cannot be set to <code>lower</code>
* </pre></p>
*/
private final boolean lowerStrict;
/**
- * Creates a new Bounded object.
+ * Creates a new Bounded object.
*
- * @param lower The lower bound value
- * @param upper The upper bound value
- * @param lowerStrict True means that the value cannot be equal to
the lower bound
- * @param upperStrict True means that the value cannot be equal to
the upper bound
+ * @param lower The lower bound value
+ * @param upper The upper bound value
+ * @param lowerStrict True means that the value cannot be equal to
the lower bound
+ * @param upperStrict True means that the value cannot be equal to
the upper bound
*/
public AbstractBounded(final N lower, final N initValue, final N
upper, boolean lowerStrict, boolean upperStrict) {
if (lower == null)
@@ -95,7 +95,7 @@
/**
* Returns the upper limit of the object
*
- * @return upper
+ * @return the upper bound
*/
public N getUpperBound() {
return upper;
@@ -104,16 +104,16 @@
/**
* Returns the lower limit of the object
*
- * @return lower
+ * @return the lower bound
*/
public N getLowerBound() {
return lower;
}
/**
- * Does the value have to be strictly lower than the upper bound?
+ * Does the value have to be strictly lower than the upper bound?
*
- * @return upperStrict
+ * @return true if the upper bound is strict, otherwise false
*/
public boolean isUpperBoundStrict() {
return upperStrict;
@@ -122,7 +122,7 @@
/**
* Does the value have to be strictly greater than the lower bound?
*
- * @return lowerStrict
+ * @return true if the lower bound is strict, otherwise false
*/
public boolean isLowerBoundStrict() {
return lowerStrict;
@@ -131,16 +131,16 @@
/**
* Returns the value
*
- * @return value
+ * @return the current value of the <code>Bounded</code> object
*/
public synchronized N getValue() {
return value;
}
/**
- * Set the value <code>v</code> as the value of the Bounded Object.
+ * Set the value <code>v</code> as the value of the Bounded Object.
*
- * @param v the Value
+ * @param v the value to be set
*/
public void setValue(final N v) {
if (v == null)
@@ -171,5 +171,9 @@
}
}
+ /** Sets the value of the <code>Bounded</code> object.
+ *
+ * @param s will be converted to the value type of the
<code>Bounded</code> object.
+ */
public abstract void setValue(String s);
}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
