View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.lang3.builder;
18  
19  import static org.junit.jupiter.api.Assertions.assertEquals;
20  
21  import java.math.BigDecimal;
22  import java.math.BigInteger;
23  import java.util.ArrayList;
24  import java.util.HashMap;
25  import java.util.concurrent.atomic.AtomicBoolean;
26  import java.util.concurrent.atomic.AtomicInteger;
27  import java.util.concurrent.atomic.AtomicLong;
28  
29  import org.apache.commons.lang3.AbstractLangTest;
30  import org.apache.commons.lang3.mutable.MutableBoolean;
31  import org.apache.commons.lang3.mutable.MutableByte;
32  import org.apache.commons.lang3.mutable.MutableDouble;
33  import org.apache.commons.lang3.mutable.MutableFloat;
34  import org.apache.commons.lang3.mutable.MutableInt;
35  import org.apache.commons.lang3.mutable.MutableLong;
36  import org.apache.commons.lang3.mutable.MutableShort;
37  import org.junit.jupiter.api.AfterEach;
38  import org.junit.jupiter.api.BeforeEach;
39  import org.junit.jupiter.api.Test;
40  
41  /**
42   * Tests {@link org.apache.commons.lang3.builder.RecursiveToStringStyleTest}.
43   */
44  class RecursiveToStringStyleTest extends AbstractLangTest {
45  
46      static class Job {
47  
48          /**
49           * Test String field.
50           */
51          String title;
52      }
53      static class Person {
54  
55          /**
56           * Test String field.
57           */
58          String name;
59  
60          /**
61           * Test integer field.
62           */
63          int age;
64  
65          /**
66           * Test boolean field.
67           */
68          boolean smoker;
69  
70          /**
71           * Test Object field.
72           */
73          Job job;
74      }
75  
76      private final Integer base = Integer.valueOf(5);
77  
78      private final String baseStr = base.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(base));
79  
80      @BeforeEach
81      public void setUp() {
82          ToStringBuilder.setDefaultStyle(new RecursiveToStringStyle());
83      }
84  
85      @AfterEach
86      public void tearDown() {
87          ToStringBuilder.setDefaultStyle(ToStringStyle.DEFAULT_STYLE);
88      }
89  
90      @Test
91      void testAppendSuper() {
92          assertEquals(baseStr + "[]", new ToStringBuilder(base).appendSuper("Integer@8888[]").toString());
93          assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).appendSuper("Integer@8888[<null>]").toString());
94  
95          assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendSuper("Integer@8888[]").append("a", "hello").toString());
96          assertEquals(baseStr + "[<null>,a=hello]", new ToStringBuilder(base).appendSuper("Integer@8888[<null>]").append("a", "hello").toString());
97          assertEquals(baseStr + "[a=hello]", new ToStringBuilder(base).appendSuper(null).append("a", "hello").toString());
98      }
99  
100     @Test
101     void testAtomicsArray() {
102         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
103                 new ToStringBuilder(base).append(new Object[] { null, base, new AtomicLong[] { new AtomicLong(3), new AtomicLong(6) } }).toString());
104         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
105                 new ToStringBuilder(base).append(new Object[] { null, base, new AtomicInteger[] { new AtomicInteger(3), new AtomicInteger(6) } }).toString());
106         assertEquals(baseStr + "[{<null>,5,{true,false}}]",
107                 new ToStringBuilder(base).append(new Object[] { null, base, new AtomicBoolean[] { new AtomicBoolean(true), new AtomicBoolean(false) } }).toString());
108     }
109 
110     @Test
111     void testBigDecimal() {
112         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
113                 new ToStringBuilder(base).append(new Object[] { null, base, new BigDecimal[] { BigDecimal.valueOf(3), BigDecimal.valueOf(6) } }).toString());
114         assertEquals(baseStr + "[{<null>,5,{3.0,6.0}}]",
115                 new ToStringBuilder(base).append(new Object[] { null, base, new BigDecimal[] { BigDecimal.valueOf(3.0), BigDecimal.valueOf(6.0) } }).toString());
116     }
117 
118     @Test
119     void testBigInteger() {
120         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
121                 new ToStringBuilder(base).append(new Object[] { null, base, new BigInteger[] { BigInteger.valueOf(3), BigInteger.valueOf(6) } }).toString());
122     }
123 
124     @Test
125     void testBlank() {
126         assertEquals(baseStr + "[]", new ToStringBuilder(base).toString());
127     }
128 
129     @Test
130     void testLong() {
131         assertEquals(baseStr + "[3]", new ToStringBuilder(base).append(3L).toString());
132         assertEquals(baseStr + "[a=3]", new ToStringBuilder(base).append("a", 3L).toString());
133         assertEquals(baseStr + "[a=3,b=4]", new ToStringBuilder(base).append("a", 3L).append("b", 4L).toString());
134     }
135 
136     @Test
137     void testLongArray() {
138         long[] array = {1, 2, -3, 4};
139         assertEquals(baseStr + "[{1,2,-3,4}]", new ToStringBuilder(base).append(array).toString());
140         assertEquals(baseStr + "[{1,2,-3,4}]", new ToStringBuilder(base).append((Object) array).toString());
141         array = null;
142         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append(array).toString());
143         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) array).toString());
144     }
145 
146     @Test
147     void testLongArrayArray() {
148         long[][] array = {{1, 2}, null, {5}};
149         assertEquals(baseStr + "[{{1,2},<null>,{5}}]", new ToStringBuilder(base).append(array).toString());
150         assertEquals(baseStr + "[{{1,2},<null>,{5}}]", new ToStringBuilder(base).append((Object) array).toString());
151         array = null;
152         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append(array).toString());
153         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) array).toString());
154     }
155 
156     @Test
157     void testMutableWrapperArray() {
158         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
159                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableLong[] { new MutableLong(3), new MutableLong(6) } }).toString());
160         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
161                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableInt[] { new MutableInt(3), new MutableInt(6) } }).toString());
162         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
163                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableShort[] { new MutableShort(3), new MutableShort(6) } }).toString());
164         assertEquals(baseStr + "[{<null>,5,{3,6}}]",
165                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableByte[] { new MutableByte((byte) 3), new MutableByte((byte) 6) } }).toString());
166         assertEquals(baseStr + "[{<null>,5,{3.0,6.0}}]",
167                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableFloat[] { new MutableFloat(3f), new MutableFloat(6f) } }).toString());
168         assertEquals(baseStr + "[{<null>,5,{3.0,6.0}}]",
169                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableDouble[] { new MutableDouble(3d), new MutableDouble(6d) } }).toString());
170         assertEquals(baseStr + "[{<null>,5,{true,false}}]",
171                 new ToStringBuilder(base).append(new Object[] { null, base, new MutableBoolean[] { new MutableBoolean(true), new MutableBoolean(false) } }).toString());
172     }
173 
174     @Test
175     void testObject() {
176         final Integer i3 = Integer.valueOf(3);
177         final Integer i4 = Integer.valueOf(4);
178         final ArrayList<Object> emptyList = new ArrayList<>();
179 
180         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) null).toString());
181         assertEquals(baseStr + "[3]", new ToStringBuilder(base).append(i3).toString());
182         assertEquals(baseStr + "[a=<null>]", new ToStringBuilder(base).append("a", (Object) null).toString());
183         assertEquals(baseStr + "[a=3]", new ToStringBuilder(base).append("a", i3).toString());
184         assertEquals(baseStr + "[a=3,b=4]", new ToStringBuilder(base).append("a", i3).append("b", i4).toString());
185         assertEquals(baseStr + "[a=<Integer>]", new ToStringBuilder(base).append("a", i3, false).toString());
186         assertEquals(baseStr + "[a=<size=0>]", new ToStringBuilder(base).append("a", emptyList, false).toString());
187         assertEquals(baseStr + "[a=java.util.ArrayList@" + Integer.toHexString(System.identityHashCode(emptyList)) + "{}]",
188                 new ToStringBuilder(base).append("a", emptyList, true).toString());
189         assertEquals(baseStr + "[a=<size=0>]", new ToStringBuilder(base).append("a", new HashMap<>(), false).toString());
190         assertEquals(baseStr + "[a={}]", new ToStringBuilder(base).append("a", new HashMap<>(), true).toString());
191         assertEquals(baseStr + "[a=<size=0>]", new ToStringBuilder(base).append("a", (Object) new String[0], false).toString());
192         assertEquals(baseStr + "[a={}]", new ToStringBuilder(base).append("a", (Object) new String[0], true).toString());
193     }
194 
195     @Test
196     void testObjectArray() {
197         Object[] array = {null, base, new int[] {3, 6}};
198         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(array).toString());
199         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append((Object) array).toString());
200         array = null;
201         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append(array).toString());
202         assertEquals(baseStr + "[<null>]", new ToStringBuilder(base).append((Object) array).toString());
203     }
204 
205     @Test
206     void testPerson() {
207         final Person p = new Person();
208         p.name = "John Doe";
209         p.age = 33;
210         p.smoker = false;
211         p.job = new Job();
212         p.job.title = "Manager";
213         final String baseStr = p.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(p));
214         final String jobStr  = p.job.getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(p.job));
215         assertEquals(baseStr + "[age=33,job=" + jobStr + "[title=Manager],name=John Doe,smoker=false]",
216                      new ReflectionToStringBuilder(p, new RecursiveToStringStyle()).toString());
217     }
218 
219     @Test
220     void testPrimitiveWrapperArray() {
221         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Character[] { '3', '6' } }).toString());
222         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Long[] { 3L, 6L } }).toString());
223         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Integer[] { 3, 6 } }).toString());
224         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Short[] { 3, 6 } }).toString());
225         assertEquals(baseStr + "[{<null>,5,{3,6}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Byte[] { 3, 6 } }).toString());
226         assertEquals(baseStr + "[{<null>,5,{3.0,6.0}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Float[] { 3f, 6f } }).toString());
227         assertEquals(baseStr + "[{<null>,5,{3.0,6.0}}]", new ToStringBuilder(base).append(new Object[] { null, base, new Double[] { 3d, 6d } }).toString());
228         assertEquals(baseStr + "[{<null>,5,{true,false}}]",
229                 new ToStringBuilder(base).append(new Object[] { null, base, new Boolean[] { true, false } }).toString());
230     }
231 }