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

[LANG-586] part 2: refactor ToStringStyle and ToStringBuilderTest to verify that we are unsetting the registry when no longer needed 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@906676 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Matthew Jason Benson 2010-02-04 21:57:58 +00:00
parent 5c3ec55e15
commit a2bb711aee
2 changed files with 79 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/org/apache/commons/lang3/builder/ToStringStyle.java
View File

@ -144,9 +144,8 @@ public abstract class ToStringStyle implements Serializable {
*
* @return Set the registry of objects being traversed
*/
static Set<Object> getRegistry() {
WeakHashMap<Object, Object> m = REGISTRY.get();
return m == null ? Collections.<Object> emptySet() : m.keySet();
static Map<Object, Object> getRegistry() {
return REGISTRY.get();
}
/**
@ -161,7 +160,8 @@ public abstract class ToStringStyle implements Serializable {
* object.
*/
static boolean isRegistered(Object value) {
return getRegistry().contains(value);
Map<Object, Object> m = getRegistry();
return m != null && m.containsKey(value);
}
/**

153
src/test/java/org/apache/commons/lang3/builder/ToStringBuilderTest.java
View File

@ -5,9 +5,9 @@
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -34,7 +34,7 @@ public class ToStringBuilderTest extends TestCase {
private final Integer base = new Integer(5);
private final String baseStr = base.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(base));
public ToStringBuilderTest(String name) {
super(name);
}
@ -69,7 +69,7 @@ public class ToStringBuilderTest extends TestCase {
public void testSetDefaultEx() {
try {
ToStringBuilder.setDefaultStyle(null);
} catch (IllegalArgumentException ex) {
return;
}
@ -79,7 +79,7 @@ public class ToStringBuilderTest extends TestCase {
public void testBlank() {
assertEquals(baseStr + "[]", new ToStringBuilder(base).toString());
}
/**
* Test wrapper for int primitive.
*/
@ -114,9 +114,9 @@ public class ToStringBuilderTest extends TestCase {
private String toBaseString(Object o) {
return o.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(o));
}
// Reflection Array tests
//
// Note on the following line of code repeated in the reflection array tests.
//
@ -124,12 +124,12 @@ public class ToStringBuilderTest extends TestCase {
//
// The expected value is not baseStr + "[<null>]" since array==null and is typed as Object.
// The null array does not carry array type information.
// If we added a primitive array type constructor and pile of associated methods,
// If we added a primitive array type constructor and pile of associated methods,
// then type declaring type information could be carried forward. IMHO, null is null.
//
// Gary Gregory - 2003-03-12 - ggregory@seagullsw.com
// Gary Gregory - 2003-03-12 - ggregory@seagullsw.com
//
public void assertReflectionArray(String expected, Object actual) {
if (actual == null) {
// Until ToStringBuilder supports null objects.
@ -147,7 +147,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{<null>,5,{3,6}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionLongArray() {
@ -156,7 +156,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1,2,-3,4}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionIntArray() {
@ -165,7 +165,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1,2,-3,4}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionShortArray() {
@ -174,7 +174,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1,2,-3,4}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionyteArray() {
@ -183,7 +183,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1,2,-3,4}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionCharArray() {
@ -192,7 +192,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{A,2,_,D}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionDoubleArray() {
@ -201,7 +201,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1.0,2.9876,-3.00001,4.3}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionFloatArray() {
@ -210,7 +210,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{1.0,2.9876,-3.00001,4.3}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionBooleanArray() {
@ -219,9 +219,9 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{true,false,false}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
// Reflection Array Array tests
public void testReflectionFloatArrayArray() {
@ -230,7 +230,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1.0,2.29686},<null>,{NaN}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
@ -240,7 +240,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1,2},<null>,{5}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionIntArrayArray() {
@ -249,7 +249,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1,2},<null>,{5}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionhortArrayArray() {
@ -258,7 +258,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1,2},<null>,{5}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionByteArrayArray() {
@ -267,7 +267,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1,2},<null>,{5}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionCharArrayArray() {
@ -276,7 +276,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{A,B},<null>,{p}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionDoubleArrayArray() {
@ -285,7 +285,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{1.0,2.29686},<null>,{NaN}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionBooleanArrayArray() {
@ -295,9 +295,9 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[{{true,false},<null>,{false}}]", ToStringBuilder.reflectionToString(array));
array = null;
assertReflectionArray("<null>", array);
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
// Reflection hierarchy tests
public void testReflectionHierarchyArrayList() {
@ -305,7 +305,7 @@ public class ToStringBuilderTest extends TestCase {
String baseStr = this.toBaseString(base);
assertEquals(baseStr + "[elementData={<null>,<null>,<null>,<null>,<null>,<null>,<null>,<null>,<null>,<null>},size=0,modCount=0]", ToStringBuilder.reflectionToString(base, null, true));
assertEquals(baseStr + "[size=0]", ToStringBuilder.reflectionToString(base, null, false));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionHierarchy() {
@ -318,7 +318,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[a=a]", ToStringBuilder.reflectionToString(baseA, null, false, null));
assertEquals(baseStr + "[a=a]", ToStringBuilder.reflectionToString(baseA, null, false, Object.class));
assertEquals(baseStr + "[a=a]", ToStringBuilder.reflectionToString(baseA, null, false, ReflectionTestFixtureA.class));
ReflectionTestFixtureB baseB = new ReflectionTestFixtureB();
baseStr = this.toBaseString(baseB);
assertEquals(baseStr + "[b=b,a=a]", ToStringBuilder.reflectionToString(baseB));
@ -330,7 +330,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[b=b,a=a]", ToStringBuilder.reflectionToString(baseB, null, false, Object.class));
assertEquals(baseStr + "[b=b,a=a]", ToStringBuilder.reflectionToString(baseB, null, false, ReflectionTestFixtureA.class));
assertEquals(baseStr + "[b=b]", ToStringBuilder.reflectionToString(baseB, null, false, ReflectionTestFixtureB.class));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
static class ReflectionTestFixtureA {
@ -351,7 +351,7 @@ public class ToStringBuilderTest extends TestCase {
Outer outer = new Outer();
assertEquals(toBaseString(outer) + "[inner=" + toBaseString(outer.inner) + "[]]", outer.toString());
}
static class Outer {
Inner inner = new Inner();
class Inner {
@ -365,7 +365,7 @@ public class ToStringBuilderTest extends TestCase {
return ToStringBuilder.reflectionToString(this);
}
}
// Reflection cycle tests
/**
@ -377,7 +377,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(
this.toBaseString(objects) + "[{" + this.toBaseString(objects) + "}]",
ToStringBuilder.reflectionToString(objects));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
@ -394,7 +394,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(
this.toBaseString(objectsLevel2) + "[{{" + this.toBaseString(objectsLevel2) + "}}]",
ToStringBuilder.reflectionToString(objectsLevel2));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
public void testReflectionArrayArrayCycle() throws Exception {
@ -416,7 +416,7 @@ public class ToStringBuilderTest extends TestCase {
+ basicToString
+ "}}]",
ToStringBuilder.reflectionToString(objects));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
@ -475,7 +475,7 @@ public class ToStringBuilderTest extends TestCase {
return ToStringBuilder.reflectionToString(this);
}
}
private static class SelfInstanceTwoVarsReflectionTestFixture {
@SuppressWarnings("unused")
private SelfInstanceTwoVarsReflectionTestFixture typeIsSelf;
@ -484,7 +484,7 @@ public class ToStringBuilderTest extends TestCase {
public SelfInstanceTwoVarsReflectionTestFixture() {
this.typeIsSelf = this;
}
public String getOtherType(){
return this.otherType;
}
@ -494,50 +494,47 @@ public class ToStringBuilderTest extends TestCase {
return ToStringBuilder.reflectionToString(this);
}
}
/**
* Test an Object pointing to itself, the simplest test.
*
*
* @throws Exception
*/
public void testSimpleReflectionObjectCycle() throws Exception {
SimpleReflectionTestFixture simple = new SimpleReflectionTestFixture();
simple.o = simple;
assertTrue(ToStringStyle.getRegistry().isEmpty());
assertEquals(this.toBaseString(simple) + "[o=" + this.toBaseString(simple) + "]", simple.toString());
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
* Test a class that defines an ivar pointing to itself.
*
*
* @throws Exception
*/
public void testSelfInstanceVarReflectionObjectCycle() throws Exception {
SelfInstanceVarReflectionTestFixture test = new SelfInstanceVarReflectionTestFixture();
assertTrue(ToStringStyle.getRegistry().isEmpty());
assertEquals(this.toBaseString(test) + "[typeIsSelf=" + this.toBaseString(test) + "]", test.toString());
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
* Test a class that defines an ivar pointing to itself. This test was
* Test a class that defines an ivar pointing to itself. This test was
* created to show that handling cyclical object resulted in a missing endFieldSeparator call.
*
*
* @throws Exception
*/
public void testSelfInstanceTwoVarsReflectionObjectCycle() throws Exception {
SelfInstanceTwoVarsReflectionTestFixture test = new SelfInstanceTwoVarsReflectionTestFixture();
assertTrue(ToStringStyle.getRegistry().isEmpty());
assertEquals(this.toBaseString(test) + "[typeIsSelf=" + this.toBaseString(test) + ",otherType=" + test.getOtherType().toString() + "]", test.toString());
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
* Test Objects pointing to each other.
*
*
* @throws Exception
*/
public void testReflectionObjectCycle() throws Exception {
@ -548,13 +545,13 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(
this.toBaseString(a) + "[b=" + this.toBaseString(b) + "[a=" + this.toBaseString(a) + "]]",
a.toString());
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
/**
* Test a nasty combination of arrays and Objects pointing to each other.
* objects[0] -> SimpleReflectionTestFixture[ o -> objects ]
*
*
* @throws Exception
*/
public void testReflectionArrayAndObjectCycle() throws Exception {
@ -576,36 +573,36 @@ public class ToStringBuilderTest extends TestCase {
+ this.toBaseString(simple)
+ "}]",
ToStringBuilder.reflectionToString(simple));
this.validateEmptyToStringStyleRegistry();
this.validateNullToStringStyleRegistry();
}
void validateEmptyToStringStyleRegistry() {
if (!ToStringStyle.getRegistry().isEmpty()) {
void validateNullToStringStyleRegistry() {
if (ToStringStyle.getRegistry() != null) {
System.out.println(ToStringStyle.getRegistry());
}
assertTrue(ToStringStyle.getRegistry().isEmpty());
assertNull(ToStringStyle.getRegistry());
}
// End: Reflection cycle tests
public void testAppendSuper() {
assertEquals(baseStr + "[]", new ToStringBuilder(base).appendSuper("Integer@8888[]").toString());
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).appendSuper("Integer@8888[<null>]").toString());
assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendSuper("Integer@8888[]").append("a", "hello").toString());
assertEquals(baseStr + "[<null>,a=hello]", new ToStringBuilder(base).appendSuper("Integer@8888[<null>]").append("a", "hello").toString());
assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendSuper(null).append("a", "hello").toString());
}
public void testAppendToString() {
assertEquals(baseStr + "[]", new ToStringBuilder(base).appendToString("Integer@8888[]").toString());
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).appendToString("Integer@8888[<null>]").toString());
assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendToString("Integer@8888[]").append("a", "hello").toString());
assertEquals(baseStr + "[<null>,a=hello]", new ToStringBuilder(base).appendToString("Integer@8888[<null>]").append("a", "hello").toString());
assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendToString(null).append("a", "hello").toString());
}
public void testObject() {
Integer i3 = new Integer(3);
Integer i4 = new Integer(4);
@ -709,7 +706,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append(array).toString());
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) array).toString());
}
public void testByteArray() {
byte[] array = new byte[] {1, 2, -3, 4};
assertEquals(baseStr + "[{1,2,-3,4}]", new ToStringBuilder(base).append(array).toString());
@ -745,7 +742,7 @@ public class ToStringBuilderTest extends TestCase {
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append(array).toString());
assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) array).toString());
}
public void testBooleanArray() {
boolean[] array = new boolean[] {true, false, false};
assertEquals(baseStr + "[{true,false,false}]", new ToStringBuilder(base).append(array).toString());
@ -832,21 +829,21 @@ public class ToStringBuilderTest extends TestCase {
ObjectCycle b = new ObjectCycle();
a.obj = b;
b.obj = a;
String expected = toBaseString(a) + "[" + toBaseString(b) + "[" + toBaseString(a) + "]]";
assertEquals(expected, a.toString());
validateEmptyToStringStyleRegistry();
validateNullToStringStyleRegistry();
}
static class ObjectCycle {
Object obj;
@Override
public String toString() {
return new ToStringBuilder(this).append(obj).toString();
}
}
public void testSimpleReflectionStatics() {
SimpleReflectionStaticFieldsFixture instance1 = new SimpleReflectionStaticFieldsFixture();
assertEquals(
@ -912,12 +909,12 @@ public class ToStringBuilderTest extends TestCase {
*
* <p>Transient fields are not output.</p>
*
* <p>Superclass fields will be appended up to and including the specified superclass.
* <p>Superclass fields will be appended up to and including the specified superclass.
* A null superclass is treated as <code>java.lang.Object</code>.</p>
*
* <p>If the style is <code>null</code>, the default
* <code>ToStringStyle</code> is used.</p>
*
*
* @param object the Object to be output
* @param style the style of the <code>toString</code> to create,
* may be <code>null</code>
@ -938,7 +935,7 @@ public class ToStringBuilderTest extends TestCase {
ReflectionToStringBuilder test = new ReflectionToStringBuilder(val);
test.setUpToClass(Number.class);
}
/**
* Tests ReflectionToStringBuilder setUpToClass().
*/
@ -952,7 +949,7 @@ public class ToStringBuilderTest extends TestCase {
// expected
}
}
/**
* Tests ReflectionToStringBuilder.toString() for statics.
*/