scolebourne 2003/01/15 12:36:38
Modified: collections/src/java/org/apache/commons/collections/comparators
BooleanComparator.java
Log:
Javadoc the cached method
Revision Changes Path
1.5 +7 -2
jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/BooleanComparator.java
Index: BooleanComparator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/BooleanComparator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- BooleanComparator.java 13 Jan 2003 22:34:57 -0000 1.4
+++ BooleanComparator.java 15 Jan 2003 20:36:38 -0000 1.5
@@ -202,6 +202,11 @@
* to reduce allocation and garbage collection overhead when
* multiple BooleanComparators may be used in the same
* virtual machine.
+ *
+ * @param trueFirst when <code>true</code>, sort
+ * <code>true</code> {@link Boolean}s before
+ * <code>false</code> {@link Boolean}s.
+ * @return a cached BooleanComparator instance
*/
public static BooleanComparator getBooleanComparator(boolean trueFirst) {
return trueFirst ? TRUE_FIRST : FALSE_FIRST;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
