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

LANG-1015: Add JsonToStringStyle implementation to ToStringStyle. This fixes #12 and #26 from github. Thanks to Thiago Andrade. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1648919 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2015-01-01 19:01:41 +00:00
parent c87380f0d9
commit c4ddbe6456
3 changed files with 699 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -22,6 +22,7 @@
<body> <body>
<release version="3.4" date="tba" description="tba"> <release version="3.4" date="tba" description="tba">
<action issue="LANG-1015" type="add" dev="britter" due-to="Thiago Andrade">Add JsonToStringStyle implementation to ToStringStyle</action>
<action issue="LANG-1080" type="add" dev="britter" due-to="Innokenty Shuvalov">Add NoClassNameToStringStyle implementation of ToStringStyle</action> <action issue="LANG-1080" type="add" dev="britter" due-to="Innokenty Shuvalov">Add NoClassNameToStringStyle implementation of ToStringStyle</action>
<action issue="LANG-1071" type="update" dev="britter" due-to="Arno Noordover">Fix wrong examples in JavaDoc of StringUtils.replaceEachRepeatedly(...), StringUtils.replaceEach(...)</action> <action issue="LANG-1071" type="update" dev="britter" due-to="Arno Noordover">Fix wrong examples in JavaDoc of StringUtils.replaceEachRepeatedly(...), StringUtils.replaceEach(...)</action>
<action issue="LANG-883" type="add" dev="britter" due-to="Daniel Stewart">Add StringUtils.containsAny(CharSequence, CharSequence...) method</action> <action issue="LANG-883" type="add" dev="britter" due-to="Daniel Stewart">Add StringUtils.containsAny(CharSequence, CharSequence...) method</action>

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

@ -139,6 +139,29 @@ public abstract class ToStringStyle implements Serializable {
*/ */
public static final ToStringStyle NO_CLASS_NAME_STYLE = new NoClassNameToStringStyle(); public static final ToStringStyle NO_CLASS_NAME_STYLE = new NoClassNameToStringStyle();
/**
* The JSON toString style. Using the <code>Person</code> example from
* {@link ToStringBuilder}, the output would look like this:
*
* <pre>
* {
* "name": "John Doe",
* "age": 33,
* "smoker": true
* }
* </pre>
*
* <strong>Note:</strong> Since field names are mandatory in JSON, this
* ToStringStyle will throw an {@link UnsupportedOperationException} if no
* field name is passed in while appending. Furthermore This ToStringStyle
* will only generate valid JSON if referenced objects also produce JSON
* when calling {@code toString()} on them.
*
* @since 3.4
* @see <a href="http://json.org">json.org</a>
*/
public static final ToStringStyle JSON_STYLE = new JsonToStringStyle();
/** /**
* <p> * <p>
* A registry of objects used by <code>reflectionToString</code> methods * A registry of objects used by <code>reflectionToString</code> methods
@ -2326,4 +2349,265 @@ public abstract class ToStringStyle implements Serializable {
} }
// ----------------------------------------------------------------------------
/**
* <p>
* <code>ToStringStyle</code> that outputs with JSON format.
* </p>
*
* <p>
* This is an inner class rather than using
* <code>StandardToStringStyle</code> to ensure its immutability.
* </p>
*/
private static final class JsonToStringStyle extends ToStringStyle {
private static final long serialVersionUID = 1L;
/**
* The summary size text start <code>'&gt;'</code>.
*/
private String FIELD_NAME_PREFIX = "\"";
/**
* <p>
* Constructor.
* </p>
*
* <p>
* Use the static constant rather than instantiating.
* </p>
*/
JsonToStringStyle() {
super();
this.setUseClassName(false);
this.setUseIdentityHashCode(false);
this.setContentStart("{");
this.setContentEnd("}");
this.setArrayStart("[");
this.setArrayEnd("]");
this.setFieldSeparator(",");
this.setFieldNameValueSeparator(":");
this.setNullText("null");
this.setSummaryObjectStartText("\"<");
this.setSummaryObjectEndText(">\"");
this.setSizeStartText("\"<size=");
this.setSizeEndText(">\"");
}
@Override
public void append(StringBuffer buffer, String fieldName,
Object[] array, Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName, long[] array,
Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName, int[] array,
Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName,
short[] array, Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName, byte[] array,
Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName, char[] array,
Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName,
double[] array, Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName,
float[] array, Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName,
boolean[] array, Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, array, fullDetail);
}
@Override
public void append(StringBuffer buffer, String fieldName, Object value,
Boolean fullDetail) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
if (!isFullDetail(fullDetail)){
throw new UnsupportedOperationException(
"FullDetail must be true when using JsonToStringStyle");
}
super.append(buffer, fieldName, value, fullDetail);
}
@Override
protected void appendDetail(StringBuffer buffer, String fieldName, Object value) {
if (value == null) {
appendNullText(buffer, fieldName);
return;
}
if (value.getClass() == String.class) {
appendValueAsString(buffer, (String)value);
return;
}
buffer.append(value);
}
private void appendValueAsString(StringBuffer buffer, String value) {
buffer.append("\"" + value + "\"");
}
@Override
protected void appendFieldStart(StringBuffer buffer, String fieldName) {
if (fieldName == null) {
throw new UnsupportedOperationException(
"Field names are mandatory when using JsonToStringStyle");
}
super.appendFieldStart(buffer, FIELD_NAME_PREFIX + fieldName
+ FIELD_NAME_PREFIX);
}
/**
* <p>
* Ensure <code>Singleton</code> after serialization.
* </p>
*
* @return the singleton
*/
private Object readResolve() {
return ToStringStyle.JSON_STYLE;
}
}
} }

414
src/test/java/org/apache/commons/lang3/builder/JsonToStringStyleTest.java Normal file
View File

@ -0,0 +1,414 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* 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.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.lang3.builder;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import java.util.ArrayList;
import java.util.HashMap;
import org.apache.commons.lang3.SystemUtils;
import org.apache.commons.lang3.builder.ToStringStyleTest.Person;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
/**
* Unit tests {@link org.apache.commons.lang3.builder.JsonToStringStyleTest}.
*
* @version $Id$
*/
public class JsonToStringStyleTest {
private final Integer base = Integer.valueOf(5);
@Before
public void setUp() throws Exception {
ToStringBuilder.setDefaultStyle(ToStringStyle.JSON_STYLE);
}
@After
public void tearDown() throws Exception {
ToStringBuilder.setDefaultStyle(ToStringStyle.DEFAULT_STYLE);
}
// ----------------------------------------------------------------
@Test
public void testNull() {
assertEquals(String.valueOf((Object) null),
new ToStringBuilder(null).toString());
}
@Test
public void testBlank() {
assertEquals("{}", new ToStringBuilder(base).toString());
}
@Test
public void testAppendSuper() {
assertEquals(
"{}",
new ToStringBuilder(base).appendSuper(
"Integer@8888[" + SystemUtils.LINE_SEPARATOR + "]")
.toString());
assertEquals(
"{}",
new ToStringBuilder(base).appendSuper(
"Integer@8888[" + SystemUtils.LINE_SEPARATOR + " null"
+ SystemUtils.LINE_SEPARATOR + "]").toString());
assertEquals(
"{\"a\":\"hello\"}",
new ToStringBuilder(base)
.appendSuper(
"Integer@8888[" + SystemUtils.LINE_SEPARATOR
+ "]").append("a", "hello").toString());
assertEquals(
"{\"a\":\"hello\"}",
new ToStringBuilder(base)
.appendSuper(
"Integer@8888[" + SystemUtils.LINE_SEPARATOR
+ " null" + SystemUtils.LINE_SEPARATOR
+ "]").append("a", "hello").toString());
assertEquals("{\"a\":\"hello\"}", new ToStringBuilder(base)
.appendSuper(null).append("a", "hello").toString());
}
@Test
public void testObject() {
final Integer i3 = Integer.valueOf(3);
final Integer i4 = Integer.valueOf(4);
try {
assertEquals("{\"null\":null}",
new ToStringBuilder(base).append((Object) null).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":3}", new ToStringBuilder(base).append(i3)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals("{\"a\":null}",
new ToStringBuilder(base).append("a", (Object) null).toString());
assertEquals("{\"a\":3}", new ToStringBuilder(base).append("a", i3)
.toString());
assertEquals("{\"a\":3,\"b\":4}",
new ToStringBuilder(base).append("a", i3).append("b", i4)
.toString());
try {
assertEquals("{\"a\":\"<Integer>\"}",
new ToStringBuilder(base).append("a", i3, false).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals(
"{\"a\":\"<size=0>\"}",
new ToStringBuilder(base).append("a", new ArrayList<Object>(),
false).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals(
"{\"a\":[]}",
new ToStringBuilder(base).append("a", new ArrayList<Object>(),
true).toString());
try {
assertEquals(
"{\"a\":\"<size=0>\"}",
new ToStringBuilder(base).append("a",
new HashMap<Object, Object>(), false).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals(
"{\"a\":{}}",
new ToStringBuilder(base).append("a",
new HashMap<Object, Object>(), true).toString());
try {
assertEquals(
"{\"a\":\"<size=0>\"}",
new ToStringBuilder(base).append("a", (Object) new String[0],
false).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals(
"{\"a\":[]}",
new ToStringBuilder(base).append("a", (Object) new String[0],
true).toString());
try {
assertEquals(
"{\"a\":\"<size=3>\"}",
new ToStringBuilder(base).append("a",
(Object) new int[] { 1, 2, 3 }, false).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals(
"{\"a\":[1,2,3]}",
new ToStringBuilder(base).append("a",
(Object) new int[] { 1, 2, 3 }, true).toString());
try {
assertEquals(
"{\"a\":\"<size=4>\"}",
new ToStringBuilder(base).append("a",
(Object) new String[] { "v", "x", "y", "z" }, false)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals(
"{\"a\":[\"v\",\"x\",\"y\",\"z\"]}",
new ToStringBuilder(base).append("a",
(Object) new String[] { "v", "x", "y", "z" }, true)
.toString());
}
@Test
public void testPerson() {
final Person p = new Person();
p.name = "Jane Doe";
p.age = 25;
p.smoker = true;
assertEquals(
"{\"name\":\"Jane Doe\",\"age\":25,\"smoker\":true}",
new ToStringBuilder(p).append("name", p.name)
.append("age", p.age).append("smoker", p.smoker)
.toString());
}
@Test
public void testLong() {
try {
assertEquals("{\"null\":3}", new ToStringBuilder(base).append(3L)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
assertEquals("{\"a\":3}", new ToStringBuilder(base).append("a", 3L)
.toString());
assertEquals("{\"a\":3,\"b\":4}",
new ToStringBuilder(base).append("a", 3L).append("b", 4L)
.toString());
}
@Test
public void testObjectArray() {
Object[] array = new Object[] { null, base, new int[] { 3, 6 } };
try {
assertEquals("{\"null\":[null,5,[3,6]]}", new ToStringBuilder(base)
.append(array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":[null,5,[3,6]]}", new ToStringBuilder(base)
.append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
array = null;
try {
assertEquals("{\"null\":null}", new ToStringBuilder(base).append(array)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":null}",
new ToStringBuilder(base).append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
}
@Test
public void testLongArray() {
long[] array = new long[] { 1, 2, -3, 4 };
try {
assertEquals("{\"null\":[1,2,-3,4]}",
new ToStringBuilder(base).append(array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":[1,2,-3,4]}",
new ToStringBuilder(base).append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
array = null;
try {
assertEquals("{\"null\":null}", new ToStringBuilder(base).append(array)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":null}",
new ToStringBuilder(base).append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
}
@Test
public void testLongArrayArray() {
long[][] array = new long[][] { { 1, 2 }, null, { 5 } };
try {
assertEquals("{\"null\":[[1,2],null,[5]]}", new ToStringBuilder(base)
.append(array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":[[1,2],null,[5]]}", new ToStringBuilder(base)
.append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
array = null;
try {
assertEquals("{\"null\":null}", new ToStringBuilder(base).append(array)
.toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
try {
assertEquals("{\"null\":null}",
new ToStringBuilder(base).append((Object) array).toString());
fail("Should have generated UnsupportedOperationException");
} catch (UnsupportedOperationException e) {
}
}
}