Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[LANG-713] [patch] Increase test coverage of FieldUtils read methods and tweak javadoc. Apply patch. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1142555 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2011-07-04 06:18:26 +00:00
parent 0b1db833f2
commit 3e792ce0c5
4 changed files with 225 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
RELEASE-NOTES.txt
View File

@ -103,6 +103,7 @@ IMPROVEMENTS IN 3.0
[LANG-668] Change ObjectUtils min() & max() functions to use varargs rather than just two parameters [LANG-668] Change ObjectUtils min() & max() functions to use varargs rather than just two parameters
[LANG-681] Push down WordUtils to "text" sub-package. [LANG-681] Push down WordUtils to "text" sub-package.
[LANG-711] Add includeantruntime=false to javac targets to quell warnings in ant 1.8.1 and better (and modest performance gain). [LANG-711] Add includeantruntime=false to javac targets to quell warnings in ant 1.8.1 and better (and modest performance gain).
[LANG-713] Increase test coverage of FieldUtils read methods and tweak javadoc
BUG FIXES IN 3.0 BUG FIXES IN 3.0
================ ================

8
src/main/java/org/apache/commons/lang3/reflect/FieldUtils.java
View File

@ -217,7 +217,7 @@ public class FieldUtils {
* @param cls the class to reflect, must not be null * @param cls the class to reflect, must not be null
* @param fieldName the field name to obtain * @param fieldName the field name to obtain
* @return the value of the field * @return the value of the field
* @throws IllegalArgumentException if the class or field name is null * @throws IllegalArgumentException if the class is null, the field name is null or if the field could not be found
* @throws IllegalAccessException if the field is not accessible * @throws IllegalAccessException if the field is not accessible
*/ */
public static Object readStaticField(Class<?> cls, String fieldName) throws IllegalAccessException { public static Object readStaticField(Class<?> cls, String fieldName) throws IllegalAccessException {
@ -232,7 +232,7 @@ public class FieldUtils {
* <code>setAccessible</code> method. <code>False</code> will only * <code>setAccessible</code> method. <code>False</code> will only
* match public fields. * match public fields.
* @return the Field object * @return the Field object
* @throws IllegalArgumentException if the class or field name is null * @throws IllegalArgumentException if the class is null, the field name is null or if the field could not be found
* @throws IllegalAccessException if the field is not made accessible * @throws IllegalAccessException if the field is not made accessible
*/ */
public static Object readStaticField(Class<?> cls, String fieldName, boolean forceAccess) public static Object readStaticField(Class<?> cls, String fieldName, boolean forceAccess)
@ -252,7 +252,7 @@ public class FieldUtils {
* @param cls the class to reflect, must not be null * @param cls the class to reflect, must not be null
* @param fieldName the field name to obtain * @param fieldName the field name to obtain
* @return the value of the field * @return the value of the field
* @throws IllegalArgumentException if the class or field name is null * @throws IllegalArgumentException if the class is null, the field name is null or if the field could not be found
* @throws IllegalAccessException if the field is not accessible * @throws IllegalAccessException if the field is not accessible
*/ */
public static Object readDeclaredStaticField(Class<?> cls, String fieldName) throws IllegalAccessException { public static Object readDeclaredStaticField(Class<?> cls, String fieldName) throws IllegalAccessException {
@ -269,7 +269,7 @@ public class FieldUtils {
* <code>setAccessible</code> method. <code>False</code> will only * <code>setAccessible</code> method. <code>False</code> will only
* match public fields. * match public fields.
* @return the Field object * @return the Field object
* @throws IllegalArgumentException if the class or field name is null * @throws IllegalArgumentException if the class is null, the field name is null or if the field could not be found
* @throws IllegalAccessException if the field is not made accessible * @throws IllegalAccessException if the field is not made accessible
*/ */
public static Object readDeclaredStaticField(Class<?> cls, String fieldName, boolean forceAccess) public static Object readDeclaredStaticField(Class<?> cls, String fieldName, boolean forceAccess)

2
src/site/changes/changes.xml
View File

@ -22,6 +22,8 @@
<body> <body>
<release version="3.0" date="Unreleased" description="Backwards incompatible update of Commons Lang to Java 5"> <release version="3.0" date="Unreleased" description="Backwards incompatible update of Commons Lang to Java 5">
<action type="update" issue="LANG-713">Increase test coverage of FieldUtils read methods and tweak javadoc</action>
<action type="fix" issue="LANG-711">Add includeantruntime=false to javac targets to quell warnings in ant 1.8.1 and better (and modest performance gain).</action>
<action type="fix" issue="LANG-710">StringIndexOutOfBoundsException when calling unescapeHtml4("&amp;#03")</action> <action type="fix" issue="LANG-710">StringIndexOutOfBoundsException when calling unescapeHtml4("&amp;#03")</action>
<action type="fix" issue="LANG-703">StringUtils.join throws NPE when toString returns null for one of objects in collection</action> <action type="fix" issue="LANG-703">StringUtils.join throws NPE when toString returns null for one of objects in collection</action>
<action type="add" issue="LANG-697">Add FormattableUtils class</action> <action type="add" issue="LANG-697">Add FormattableUtils class</action>

218
src/test/java/org/apache/commons/lang3/reflect/FieldUtilsTest.java
View File

@ -16,6 +16,8 @@
*/ */
package org.apache.commons.lang3.reflect; package org.apache.commons.lang3.reflect;
import static org.junit.Assume.*;
import java.lang.reflect.Constructor; import java.lang.reflect.Constructor;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.lang.reflect.Modifier; import java.lang.reflect.Modifier;
@ -86,6 +88,20 @@ public class FieldUtilsTest extends TestCase {
assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "b")); assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "b"));
assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "i")); assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "i"));
assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "d")); assertNull(FieldUtils.getField(PrivatelyShadowedChild.class, "d"));
try {
FieldUtils.getField(null, "none");
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.getField(PublicChild.class, null);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testGetFieldForceAccess() { public void testGetFieldForceAccess() {
@ -112,6 +128,20 @@ public class FieldUtilsTest extends TestCase {
.getDeclaringClass()); .getDeclaringClass());
assertEquals(PrivatelyShadowedChild.class, FieldUtils.getField(PrivatelyShadowedChild.class, "d", true) assertEquals(PrivatelyShadowedChild.class, FieldUtils.getField(PrivatelyShadowedChild.class, "d", true)
.getDeclaringClass()); .getDeclaringClass());
try {
FieldUtils.getField(null, "none", true);
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.getField(PublicChild.class, null, true);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testGetDeclaredField() { public void testGetDeclaredField() {
@ -134,6 +164,20 @@ public class FieldUtilsTest extends TestCase {
assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "b")); assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "b"));
assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "i")); assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "i"));
assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "d")); assertNull(FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "d"));
try {
FieldUtils.getDeclaredField(null, "none");
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.getDeclaredField(PublicChild.class, null);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testGetDeclaredFieldForceAccess() { public void testGetDeclaredFieldForceAccess() {
@ -161,15 +205,62 @@ public class FieldUtilsTest extends TestCase {
.getDeclaringClass()); .getDeclaringClass());
assertEquals(PrivatelyShadowedChild.class, FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "d", true) assertEquals(PrivatelyShadowedChild.class, FieldUtils.getDeclaredField(PrivatelyShadowedChild.class, "d", true)
.getDeclaringClass()); .getDeclaringClass());
try {
FieldUtils.getDeclaredField(null, "none", true);
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.getDeclaredField(PublicChild.class, null, true);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadStaticField() throws Exception { public void testReadStaticField() throws Exception {
assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(Foo.class, "VALUE"))); assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(Foo.class, "VALUE")));
try {
FieldUtils.readStaticField(null);
fail("null field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
Field nonStaticField = FieldUtils.getField(PublicChild.class, "s");
assumeNotNull(nonStaticField);
FieldUtils.readStaticField(nonStaticField);
fail("non-static field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadStaticFieldForceAccess() throws Exception { public void testReadStaticFieldForceAccess() throws Exception {
assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(Foo.class, "VALUE"))); assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(Foo.class, "VALUE")));
assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(PublicChild.class, "VALUE"))); assertEquals(Foo.VALUE, FieldUtils.readStaticField(FieldUtils.getField(PublicChild.class, "VALUE")));
try {
FieldUtils.readStaticField(null, true);
fail("null field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
Field nonStaticField = FieldUtils.getField(PublicChild.class, "s", true);
assumeNotNull(nonStaticField);
FieldUtils.readStaticField(nonStaticField);
fail("non-static field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadNamedStaticField() throws Exception { public void testReadNamedStaticField() throws Exception {
@ -177,6 +268,34 @@ public class FieldUtilsTest extends TestCase {
assertEquals(Foo.VALUE, FieldUtils.readStaticField(PubliclyShadowedChild.class, "VALUE")); assertEquals(Foo.VALUE, FieldUtils.readStaticField(PubliclyShadowedChild.class, "VALUE"));
assertEquals(Foo.VALUE, FieldUtils.readStaticField(PrivatelyShadowedChild.class, "VALUE")); assertEquals(Foo.VALUE, FieldUtils.readStaticField(PrivatelyShadowedChild.class, "VALUE"));
assertEquals(Foo.VALUE, FieldUtils.readStaticField(PublicChild.class, "VALUE")); assertEquals(Foo.VALUE, FieldUtils.readStaticField(PublicChild.class, "VALUE"));
try {
FieldUtils.readStaticField(null, "none");
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(Foo.class, null);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(Foo.class, "does_not_exist");
fail("a field that doesn't exist should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(PublicChild.class, "s");
fail("non-static field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadNamedStaticFieldForceAccess() throws Exception { public void testReadNamedStaticFieldForceAccess() throws Exception {
@ -184,6 +303,34 @@ public class FieldUtilsTest extends TestCase {
assertEquals(Foo.VALUE, FieldUtils.readStaticField(PubliclyShadowedChild.class, "VALUE", true)); assertEquals(Foo.VALUE, FieldUtils.readStaticField(PubliclyShadowedChild.class, "VALUE", true));
assertEquals(Foo.VALUE, FieldUtils.readStaticField(PrivatelyShadowedChild.class, "VALUE", true)); assertEquals(Foo.VALUE, FieldUtils.readStaticField(PrivatelyShadowedChild.class, "VALUE", true));
assertEquals("child", FieldUtils.readStaticField(PublicChild.class, "VALUE", true)); assertEquals("child", FieldUtils.readStaticField(PublicChild.class, "VALUE", true));
try {
FieldUtils.readStaticField(null, "none", true);
fail("null class should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(Foo.class, null, true);
fail("null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(Foo.class, "does_not_exist", true);
fail("a field that doesn't exist should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readStaticField(PublicChild.class, "s", false);
fail("non-static field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadDeclaredNamedStaticField() throws Exception { public void testReadDeclaredNamedStaticField() throws Exception {
@ -242,6 +389,13 @@ public class FieldUtilsTest extends TestCase {
assertEquals(D0, FieldUtils.readField(parentD, publicChild)); assertEquals(D0, FieldUtils.readField(parentD, publicChild));
assertEquals(D0, FieldUtils.readField(parentD, publiclyShadowedChild)); assertEquals(D0, FieldUtils.readField(parentD, publiclyShadowedChild));
assertEquals(D0, FieldUtils.readField(parentD, privatelyShadowedChild)); assertEquals(D0, FieldUtils.readField(parentD, privatelyShadowedChild));
try {
FieldUtils.readField((Field)null, publicChild);
fail("a null field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadFieldForceAccess() throws Exception { public void testReadFieldForceAccess() throws Exception {
@ -265,12 +419,34 @@ public class FieldUtilsTest extends TestCase {
assertEquals(D0, FieldUtils.readField(parentD, publicChild, true)); assertEquals(D0, FieldUtils.readField(parentD, publicChild, true));
assertEquals(D0, FieldUtils.readField(parentD, publiclyShadowedChild, true)); assertEquals(D0, FieldUtils.readField(parentD, publiclyShadowedChild, true));
assertEquals(D0, FieldUtils.readField(parentD, privatelyShadowedChild, true)); assertEquals(D0, FieldUtils.readField(parentD, privatelyShadowedChild, true));
try {
FieldUtils.readField((Field)null, publicChild, true);
fail("a null field should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadNamedField() throws Exception { public void testReadNamedField() throws Exception {
assertEquals("s", FieldUtils.readField(publicChild, "s")); assertEquals("s", FieldUtils.readField(publicChild, "s"));
assertEquals("ss", FieldUtils.readField(publiclyShadowedChild, "s")); assertEquals("ss", FieldUtils.readField(publiclyShadowedChild, "s"));
assertEquals("s", FieldUtils.readField(privatelyShadowedChild, "s")); assertEquals("s", FieldUtils.readField(privatelyShadowedChild, "s"));
try {
FieldUtils.readField(publicChild, null);
fail("a null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readField((Object)null, "none");
fail("a null target should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try { try {
assertEquals(Boolean.FALSE, FieldUtils.readField(publicChild, "b")); assertEquals(Boolean.FALSE, FieldUtils.readField(publicChild, "b"));
fail("expected IllegalArgumentException"); fail("expected IllegalArgumentException");
@ -325,9 +501,37 @@ public class FieldUtilsTest extends TestCase {
assertEquals(D0, FieldUtils.readField(publicChild, "d", true)); assertEquals(D0, FieldUtils.readField(publicChild, "d", true));
assertEquals(D1, FieldUtils.readField(publiclyShadowedChild, "d", true)); assertEquals(D1, FieldUtils.readField(publiclyShadowedChild, "d", true));
assertEquals(D1, FieldUtils.readField(privatelyShadowedChild, "d", true)); assertEquals(D1, FieldUtils.readField(privatelyShadowedChild, "d", true));
try {
FieldUtils.readField(publicChild, null, true);
fail("a null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readField((Object)null, "none", true);
fail("a null target should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
} }
public void testReadDeclaredNamedField() throws Exception { public void testReadDeclaredNamedField() throws Exception {
try {
FieldUtils.readDeclaredField(publicChild, null);
fail("a null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readDeclaredField((Object)null, "none");
fail("a null target should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try { try {
assertEquals("s", FieldUtils.readDeclaredField(publicChild, "s")); assertEquals("s", FieldUtils.readDeclaredField(publicChild, "s"));
fail("expected IllegalArgumentException"); fail("expected IllegalArgumentException");
@ -383,6 +587,20 @@ public class FieldUtilsTest extends TestCase {
} }
public void testReadDeclaredNamedFieldForceAccess() throws Exception { public void testReadDeclaredNamedFieldForceAccess() throws Exception {
try {
FieldUtils.readDeclaredField(publicChild, null, true);
fail("a null field name should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try {
FieldUtils.readDeclaredField((Object)null, "none", true);
fail("a null target should cause an IllegalArgumentException");
} catch (IllegalArgumentException e) {
// expected
}
try { try {
assertEquals("s", FieldUtils.readDeclaredField(publicChild, "s", true)); assertEquals("s", FieldUtils.readDeclaredField(publicChild, "s", true));
fail("expected IllegalArgumentException"); fail("expected IllegalArgumentException");