scolebourne 2003/07/25 15:37:59
Modified: lang/src/java/org/apache/commons/lang ObjectUtils.java
lang/src/test/org/apache/commons/lang ObjectUtilsTest.java
Log:
Javadoc and tests for ObjectUtils
Revision Changes Path
1.14 +39 -6
jakarta-commons/lang/src/java/org/apache/commons/lang/ObjectUtils.java
Index: ObjectUtils.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/ObjectUtils.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- ObjectUtils.java 20 Jul 2003 15:41:52 -0000 1.13
+++ ObjectUtils.java 25 Jul 2003 22:37:58 -0000 1.14
@@ -105,6 +105,14 @@
/**
* <p>Returns a default value if the object passed is
* <code>null</code>.</p>
+ *
+ * <pre>
+ * ObjectUtils.defaultIfNull(null, null) = null
+ * ObjectUtils.defaultIfNull(null, "") = ""
+ * ObjectUtils.defaultIfNull(null, "zz") = "zz"
+ * ObjectUtils.defaultIfNull("abc", *) = "abc"
+ * ObjectUtils.defaultIfNull(Boolean.TRUE, *) = Boolean.TRUE
+ * </pre>
*
* @param object the <code>Object</code> to test, may be <code>null</code>
* @param defaultValue the default value to return, may be <code>null</code>
@@ -118,6 +126,17 @@
* <p>Compares two objects for equality, where either one or both
* objects may be <code>null</code>.</p>
*
+ * <pre>
+ * ObjectUtils.equals(null, null) = true
+ * ObjectUtils.equals(null, "") = false
+ * ObjectUtils.equals("", null) = false
+ * ObjectUtils.equals("", "") = true
+ * ObjectUtils.equals(Boolean.TRUE, null) = false
+ * ObjectUtils.equals(Boolean.TRUE, "true") = false
+ * ObjectUtils.equals(Boolean.TRUE, Boolean.TRUE) = true
+ * ObjectUtils.equals(Boolean.TRUE, Boolean.FALSE) = false
+ * </pre>
+ *
* @param object1 the first object, may be <code>null</code>
* @param object2 the second object, may be <code>null</code>
* @return <code>true</code> if the values of both objects are the same
@@ -138,6 +157,12 @@
* if a class did not override toString itself. <code>null</code>
* will return <code>null</code>.</p>
*
+ * <pre>
+ * ObjectUtils.identityToString(null) = null
+ * ObjectUtils.identityToString("") = "[EMAIL PROTECTED]"
+ * ObjectUtils.identityToString(Boolean.TRUE) = "[EMAIL PROTECTED]"
+ * </pre>
+ *
* @param object the object to create a toString for, may be
* <code>null</code>
* @return the default toString text, or <code>null</code> if
@@ -147,7 +172,7 @@
if (object == null) {
return null;
}
- return appendIdentityToString(new StringBuffer(), object).toString();
+ return appendIdentityToString(null, object).toString();
}
/**
@@ -155,16 +180,24 @@
* if a class did not override toString itself. <code>null</code>
* will return <code>null</code>.</p>
*
- * @param buffer the buffer to append to, may not be
- * <code>null</code>
- * @param object the object to create a toString for, may be
- * <code>null</code>
+ * <pre>
+ * ObjectUtils.appendIdentityToString(*, null) = null
+ * ObjectUtils.appendIdentityToString(null, "") = "[EMAIL PROTECTED]"
+ * ObjectUtils.appendIdentityToString(null, Boolean.TRUE) = "[EMAIL PROTECTED]"
+ * ObjectUtils.appendIdentityToString(buf, Boolean.TRUE) = buf.append("[EMAIL
PROTECTED]")
+ * </pre>
+ *
+ * @param buffer the buffer to append to, may be <code>null</code>
+ * @param object the object to create a toString for, may be <code>null</code>
* @return the default toString text, or <code>null</code> if
* <code>null</code> passed in
*/
public static StringBuffer appendIdentityToString(StringBuffer buffer, Object
object) {
if (object == null) {
return null;
+ }
+ if (buffer == null) {
+ buffer = new StringBuffer();
}
return buffer
.append(object.getClass().getName())
1.7 +13 -6
jakarta-commons/lang/src/test/org/apache/commons/lang/ObjectUtilsTest.java
Index: ObjectUtilsTest.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/test/org/apache/commons/lang/ObjectUtilsTest.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ObjectUtilsTest.java 20 Jul 2003 15:41:52 -0000 1.6
+++ ObjectUtilsTest.java 25 Jul 2003 22:37:59 -0000 1.7
@@ -111,6 +111,7 @@
}
public void testIdentityToString() {
+ assertEquals(null, ObjectUtils.identityToString(null));
assertEquals(
"java.lang.String@" + Integer.toHexString(System.identityHashCode(FOO)),
ObjectUtils.identityToString(FOO));
@@ -118,18 +119,24 @@
assertEquals(
"java.lang.Integer@" + Integer.toHexString(System.identityHashCode(i)),
ObjectUtils.identityToString(i));
- assertEquals(null, ObjectUtils.identityToString(null));
}
public void testAppendIdentityToString() {
+ assertEquals(null, ObjectUtils.appendIdentityToString(null, null));
+ assertEquals(null, ObjectUtils.appendIdentityToString(new StringBuffer(),
null));
+ assertEquals(
+ "java.lang.String@" + Integer.toHexString(System.identityHashCode(FOO)),
+ ObjectUtils.appendIdentityToString(null, FOO).toString());
assertEquals(
"java.lang.String@" + Integer.toHexString(System.identityHashCode(FOO)),
ObjectUtils.appendIdentityToString(new StringBuffer(), FOO).toString());
- Integer i = new Integer(90);
+ Integer val = new Integer(90);
assertEquals(
- "java.lang.Integer@" + Integer.toHexString(System.identityHashCode(i)),
- ObjectUtils.appendIdentityToString(new StringBuffer(), i).toString());
- assertEquals(null, ObjectUtils.appendIdentityToString(new StringBuffer(),
null));
+ "java.lang.Integer@" +
Integer.toHexString(System.identityHashCode(val)),
+ ObjectUtils.appendIdentityToString(null, val).toString());
+ assertEquals(
+ "java.lang.Integer@" +
Integer.toHexString(System.identityHashCode(val)),
+ ObjectUtils.appendIdentityToString(new StringBuffer(), val).toString());
}
public void testToString_Object() {
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
