commons-lang-1.0.1.jar - Apache Commons Lang
commons-lang-1.0.1.jar is the JAR file for Apache Commons Lang 1.0.1, which
provides a host of helper utilities for the java.lang API.
JAR File Size and Download Location:
File name: commons-lang-1.0.1.jar File size: 63980 bytes Date modified: 11/22/2002 Download: Apache Commons Lang Website
✍: FYIcenter.com
⏎ org/apache/commons/lang/builder/ToStringStyle.java
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.lang.builder;
import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import org.apache.commons.lang.SystemUtils;
/**
* <code>ToStringStyle</code> works with ToStringBuilder to create a
* toString. The main public interface is always via ToStringBuilder.
* <p>
* These classes are intended to be used as singletons. There is no need
* to instantiate a new style each time. A program will generally use one
* of the predefined constants on this class. Alternatively, the
* {@link StandardToStringStyle} class can be used to set the individual
* settings. Thus most styles can be achieved without subclassing.
* <p>
* If required, a subclass can override as many or as few of the methods as
* it requires.Each object type (from boolean to long to Object to int[]) has
* its own methods to output it. Most have two versions, detail and summary. For
* example, the detail version of the array based methods will output the
* whole array, whereas the summary method will just output the array length.
*
* @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
* @version $Id: ToStringStyle.java,v 1.4.2.1 2002/11/22 23:20:57 bayard Exp $
*/
public abstract class ToStringStyle implements Serializable {
/**
* The default toString style.
*/
public static final ToStringStyle DEFAULT_STYLE = new DefaultToStringStyle();
/**
* The multi line toString style.
*/
public static final ToStringStyle MULTI_LINE_STYLE = new MultiLineToStringStyle();
/**
* The no field names toString style.
*/
public static final ToStringStyle NO_FIELD_NAMES_STYLE = new NoFieldNameToStringStyle();
/**
* The simple toString style.
*/
public static final ToStringStyle SIMPLE_STYLE = new SimpleToStringStyle();
/**
* Whether to use the field names 'true'
*/
private boolean useFieldNames = true;
/**
* Whether to use the class name 'true'
*/
private boolean useClassName = true;
/**
* Whether to use short class names 'false'
*/
private boolean useShortClassName = false;
/**
* Whether to use the identity hash code 'true'
*/
private boolean useIdentityHashCode = true;
/**
* The content start '['
*/
private String contentStart = "[";
/**
* The content end ']'
*/
private String contentEnd = "]";
/**
* The field name value separator '='
*/
private String fieldNameValueSeparator = "=";
/**
* The field separator ','
*/
private String fieldSeparator = ",";
/**
* The array start '{'
*/
private String arrayStart = "{";
/**
* The array separator ','
*/
private String arraySeparator = ",";
/**
* The detail for array content
*/
private boolean arrayContentDetail = true;
/**
* The array end '}'
*/
private String arrayEnd = "}";
/**
* The value to use when fullDetail is null 'true'
*/
private boolean defaultFullDetail = true;
/**
* The null text '<null>'
*/
private String nullText = "<null>";
/**
* The summary size text start '<size'
*/
private String sizeStartText = "<size=";
/**
* The summary size text start '>'
*/
private String sizeEndText = ">";
/**
* The summary object text start '<'
*/
private String summaryObjectStartText = "<";
/**
* The summary object text start '>'
*/
private String summaryObjectEndText = ">";
//----------------------------------------------------------------------------
/**
* Constructor.
*/
protected ToStringStyle() {
super();
}
//----------------------------------------------------------------------------
/**
* Append the start of data indicator.
*
* @param buffer the StringBuffer to populate
* @param object the object to build a toString for, must not be null
*/
public void appendStart(StringBuffer buffer, Object object) {
appendClassName(buffer, object);
appendIdentityHashCode(buffer, object);
appendContentStart(buffer);
}
/**
* Append the end of data indicator.
*
* @param buffer the StringBuffer to populate
* @param object the object to build a toString for, must not be null
*/
public void appendEnd(StringBuffer buffer, Object object) {
appendContentEnd(buffer);
}
//----------------------------------------------------------------------------
/**
* Append to the toString an Object value, printing the full
* toString of the object passed in.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, Object value, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (value == null) {
appendNullText(buffer, fieldName);
} else {
appendInternal(buffer, fieldName, value, isFullDetail(fullDetail));
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString an Object, correctly interpretting its type.
* <p>
* This method performs the main lookup by Class type to correctly route
* arrays, collections, maps and objects to the appropriate method. Either
* detail or summary views can be specified.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString, not null
* @param detail output detail or not
*/
protected void appendInternal(StringBuffer buffer, String fieldName, Object value, boolean detail) {
if (value instanceof Collection) {
if (detail) {
appendDetail(buffer, fieldName, (Collection) value);
} else {
appendSummarySize(buffer, fieldName, ((Collection) value).size());
}
} else if (value instanceof Map) {
if (detail) {
appendDetail(buffer, fieldName, (Map) value);
} else {
appendSummarySize(buffer, fieldName, ((Map) value).size());
}
} else if (value instanceof long[]) {
if (detail) {
appendDetail(buffer, fieldName, (long[]) value);
} else {
appendSummary(buffer, fieldName, (long[]) value);
}
} else if (value instanceof int[]) {
if (detail) {
appendDetail(buffer, fieldName, (int[]) value);
} else {
appendSummary(buffer, fieldName, (int[]) value);
}
} else if (value instanceof short[]) {
if (detail) {
appendDetail(buffer, fieldName, (short[]) value);
} else {
appendSummary(buffer, fieldName, (short[]) value);
}
} else if (value instanceof byte[]) {
if (detail) {
appendDetail(buffer, fieldName, (byte[]) value);
} else {
appendSummary(buffer, fieldName, (byte[]) value);
}
} else if (value instanceof char[]) {
if (detail) {
appendDetail(buffer, fieldName, (char[]) value);
} else {
appendSummary(buffer, fieldName, (char[]) value);
}
} else if (value instanceof double[]) {
if (detail) {
appendDetail(buffer, fieldName, (double[]) value);
} else {
appendSummary(buffer, fieldName, (double[]) value);
}
} else if (value instanceof float[]) {
if (detail) {
appendDetail(buffer, fieldName, (float[]) value);
} else {
appendSummary(buffer, fieldName, (float[]) value);
}
} else if (value instanceof boolean[]) {
if (detail) {
appendDetail(buffer, fieldName, (boolean[]) value);
} else {
appendSummary(buffer, fieldName, (boolean[]) value);
}
} else if (value.getClass().isArray()) {
if (detail) {
appendDetail(buffer, fieldName, (Object[]) value);
} else {
appendSummary(buffer, fieldName, (Object[]) value);
}
} else {
if (detail) {
appendDetail(buffer, fieldName, (Object) value);
} else {
appendSummary(buffer, fieldName, (Object) value);
}
}
}
/**
* Append to the toString an Object value, printing the full detail of the object.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, Object value) {
buffer.append(value);
}
/**
* Append to the toString a Collection.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param coll the collection to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, Collection coll) {
buffer.append(coll);
}
/**
* Append to the toString a Map.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param map the maps to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, Map map) {
buffer.append(map);
}
/**
* Append to the toString an Object value, printing a summary of the object.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, Object value) {
buffer.append(summaryObjectStartText);
buffer.append(getShortClassName(value.getClass()));
buffer.append(summaryObjectEndText);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a long value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, long value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a long value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, long value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString an int value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, int value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString an int value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, int value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a short value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, short value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a short value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, short value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a byte value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, byte value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a byte value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, byte value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a char value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, char value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a char value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, char value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a double value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, double value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a double value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, double value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a float value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, float value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a float value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, float value) {
buffer.append(value);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a boolean value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param value the value to add to the toString
*/
public void append(StringBuffer buffer, String fieldName, boolean value) {
appendFieldStart(buffer, fieldName);
appendDetail(buffer, fieldName, value);
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString a boolean value.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param value the value to add to the toString
*/
protected void appendDetail(StringBuffer buffer, String fieldName, boolean value) {
buffer.append(value);
}
/**
* Append to the toString an Object array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, Object[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
//----------------------------------------------------------------------------
/**
* Append to the toString the detail of an Object array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, Object[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
Object item = array[i];
if (i > 0) {
buffer.append(arraySeparator);
}
if (item == null) {
appendNullText(buffer, fieldName);
} else {
appendInternal(buffer, fieldName, item, arrayContentDetail);
}
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of an Object array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, Object[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a long array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, long[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a long array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, long[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a long array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, long[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString an int array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, int[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of an int array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, int[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of an int array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, int[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a short array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, short[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a short array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, short[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a short array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, short[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a byte array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, byte[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a byte array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, byte[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a byte array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, byte[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a char array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, char[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a char array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, char[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a char array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, char[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a double array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, double[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a double array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, double[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a double array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, double[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a float array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, float[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a float array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, float[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a float array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, float[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append to the toString a boolean array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
* @param array the array to add to the toString
* @param fullDetail true for detail, false for summary info, null for style decides
*/
public void append(StringBuffer buffer, String fieldName, boolean[] array, Boolean fullDetail) {
appendFieldStart(buffer, fieldName);
if (array == null) {
appendNullText(buffer, fieldName);
} else if (isFullDetail(fullDetail)) {
appendDetail(buffer, fieldName, array);
} else {
appendSummary(buffer, fieldName, array);
}
appendFieldEnd(buffer, fieldName);
}
/**
* Append to the toString the detail of a boolean array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendDetail(StringBuffer buffer, String fieldName, boolean[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
appendDetail(buffer, fieldName, array[i]);
}
buffer.append(arrayEnd);
}
/**
* Append to the toString a summary of a boolean array.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param array the array to add to the toString, not null
*/
protected void appendSummary(StringBuffer buffer, String fieldName, boolean[] array) {
appendSummarySize(buffer, fieldName, array.length);
}
//----------------------------------------------------------------------------
/**
* Append the class name.
*
* @param buffer the StringBuffer to populate
* @param object the object whose name to output
*/
protected void appendClassName(StringBuffer buffer, Object object) {
if (useClassName) {
if (useShortClassName) {
buffer.append(getShortClassName(object.getClass()));
} else {
buffer.append(object.getClass().getName());
}
}
}
/**
* Append the IdentityHashCode.
*
* @param buffer the StringBuffer to populate
* @param object the object whose id to output
*/
protected void appendIdentityHashCode(StringBuffer buffer, Object object) {
if (useIdentityHashCode) {
buffer.append('@');
buffer.append(Integer.toHexString(System.identityHashCode(object)));
}
}
/**
* Append the content start to the buffer.
*
* @param buffer the StringBuffer to populate
*/
protected void appendContentStart(StringBuffer buffer) {
buffer.append(contentStart);
}
/**
* Append the content end to the buffer.
*
* @param buffer the StringBuffer to populate
*/
protected void appendContentEnd(StringBuffer buffer) {
int len = buffer.length();
int sepLen = fieldSeparator.length();
if (len > 0 && sepLen > 0 && len >= sepLen && buffer.charAt(len - 1) == fieldSeparator.charAt(sepLen - 1)) {
buffer.setLength(len - sepLen);
}
buffer.append(contentEnd);
}
/**
* Append an indicator for null to the buffer.
* Default output is '<null>'.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendNullText(StringBuffer buffer, String fieldName) {
buffer.append(nullText);
}
/**
* Append the field separator to the buffer.
*
* @param buffer the StringBuffer to populate
*/
protected void appendFieldSeparator(StringBuffer buffer) {
buffer.append(fieldSeparator);
}
/**
* Append the field start to the buffer.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name
*/
protected void appendFieldStart(StringBuffer buffer, String fieldName) {
if (useFieldNames && fieldName != null) {
buffer.append(fieldName);
buffer.append(fieldNameValueSeparator);
}
}
/**
* Append the field end to the buffer.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
*/
protected void appendFieldEnd(StringBuffer buffer, String fieldName) {
appendFieldSeparator(buffer);
}
/**
* Append to the toString a size summary.
* <p>
* The size summary is used to summarize the contents of collections, maps
* and arrays. The text output is a prefix, the size (passed in) and a suffix.
* The default format is '<size=n>'.
*
* @param buffer the StringBuffer to populate
* @param fieldName the field name, typically not used as already appended
* @param size the size to append
*/
protected void appendSummarySize(StringBuffer buffer, String fieldName, int size) {
buffer.append(sizeStartText);
buffer.append(size);
buffer.append(sizeEndText);
}
/**
* Is this field to be output in full detail.
* <p>
* This method converts a detail request into a detail level. The calling code
* may request full detail (true), but a subclass might ignore that and always
* return false. The calling code may pass in null indicating that it doesn't
* care about the detail level. In this case the default detail level is used.
*
* @param fullDetailRequest the detail level requested
* @return whether full detail is to be shown
*/
protected boolean isFullDetail(Boolean fullDetailRequest) {
if (fullDetailRequest == null) {
return defaultFullDetail;
}
return fullDetailRequest.booleanValue();
}
/**
* Gets the short class name for a class.
* <p>
* The short class name is the name excluding the package name.
*
* @param cls the class to get the short name of
* @return the short name
*/
protected String getShortClassName(Class cls) {
String name = cls.getName();
int pos = name.lastIndexOf('.');
if (pos == -1) {
return name;
}
return name.substring(pos + 1);
}
// Setters and getters for the customizable parts of the style
// These methods are not expected to be overridden, except to make public
// (They are not public so that immutable subclasses can be written)
//---------------------------------------------------------------------
/**
* Gets whether to use the class name.
* @return the current useClassName flag
*/
protected boolean isUseClassName() {
return useClassName;
}
/**
* Sets whether to use the class name.
* @param useClassName the new useClassName flag
*/
protected void setUseClassName(boolean useClassName) {
this.useClassName = useClassName;
}
//---------------------------------------------------------------------
/**
* Gets whether to output short or long class names.
* @return the current shortClassName flag
*/
protected boolean isShortClassName() {
return useShortClassName;
}
/**
* Sets whether to output short or long class names.
* @param shortClassName the new shortClassName flag
*/
protected void setShortClassName(boolean shortClassName) {
this.useShortClassName = shortClassName;
}
//---------------------------------------------------------------------
/**
* Gets whether to use the identity hash code.
* @return the current useIdentityHashCode flag
*/
protected boolean isUseIdentityHashCode() {
return useIdentityHashCode;
}
/**
* Sets whether to use the identity hash code.
* @param useIdentityHashCode the new useIdentityHashCode flag
*/
protected void setUseIdentityHashCode(boolean useIdentityHashCode) {
this.useIdentityHashCode = useIdentityHashCode;
}
//---------------------------------------------------------------------
/**
* Gets whether to use the field names passed in.
* @return the current useFieldNames flag
*/
protected boolean isUseFieldNames() {
return useFieldNames;
}
/**
* Sets whether to use the field names passed in.
* @param useFieldNames the new useFieldNames flag
*/
protected void setUseFieldNames(boolean useFieldNames) {
this.useFieldNames = useFieldNames;
}
//---------------------------------------------------------------------
/**
* Gets whether to use full detail when the caller doesn't specify.
* @return the current defaultFullDetail flag
*/
protected boolean isDefaultFullDetail() {
return defaultFullDetail;
}
/**
* Sets whether to use full detail when the caller doesn't specify.
* @param defaultFullDetail the new defaultFullDetail flag
*/
protected void setDefaultFullDetail(boolean defaultFullDetail) {
this.defaultFullDetail = defaultFullDetail;
}
//---------------------------------------------------------------------
/**
* Gets whether to output array content detail.
* @return the current array content detail setting
*/
protected boolean isArrayContentDetail() {
return arrayContentDetail;
}
/**
* Sets whether to output array content detail.
* @param arrayContentDetail the new arrayContentDetail flag
*/
protected void setArrayContentDetail(boolean arrayContentDetail) {
this.arrayContentDetail = arrayContentDetail;
}
//---------------------------------------------------------------------
/**
* Gets the array start text.
* @return the current array start text
*/
protected String getArrayStart() {
return arrayStart;
}
/**
* Sets the array start text.
* Null is accepted, but will be converted to a blank string.
* @param arrayStart the new array start text
*/
protected void setArrayStart(String arrayStart) {
if (arrayStart == null) {
arrayStart = "";
}
this.arrayStart = arrayStart;
}
//---------------------------------------------------------------------
/**
* Gets the array end text.
* @return the current array end text
*/
protected String getArrayEnd() {
return arrayEnd;
}
/**
* Sets the array end text.
* Null is accepted, but will be converted to a blank string.
* @param arrayEnd the new array end text
*/
protected void setArrayEnd(String arrayEnd) {
if (arrayStart == null) {
arrayStart = "";
}
this.arrayEnd = arrayEnd;
}
//---------------------------------------------------------------------
/**
* Gets the array separator text.
* @return the current array separator text
*/
protected String getArraySeparator() {
return arraySeparator;
}
/**
* Sets the array separator text.
* Null is accepted, but will be converted to a blank string.
* @param arraySeparator the new array separator text
*/
protected void setArraySeparator(String arraySeparator) {
if (arraySeparator == null) {
arraySeparator = "";
}
this.arraySeparator = arraySeparator;
}
//---------------------------------------------------------------------
/**
* Gets the content start text.
* @return the current content start text
*/
protected String getContentStart() {
return contentStart;
}
/**
* Sets the content start text.
* Null is accepted, but will be converted to a blank string.
* @param contentStart the new content start text
*/
protected void setContentStart(String contentStart) {
if (contentStart == null) {
contentStart = "";
}
this.contentStart = contentStart;
}
//---------------------------------------------------------------------
/**
* Gets the content end text.
* @return the current content end text
*/
protected String getContentEnd() {
return contentEnd;
}
/**
* Sets the content end text.
* Null is accepted, but will be converted to a blank string.
* @param contentEnd the new content end text
*/
protected void setContentEnd(String contentEnd) {
if (contentEnd == null) {
contentEnd = "";
}
this.contentEnd = contentEnd;
}
//---------------------------------------------------------------------
/**
* Gets the field name value separator text.
* @return the current field name value separator text
*/
protected String getFieldNameValueSeparator() {
return fieldNameValueSeparator;
}
/**
* Sets the field name value separator text.
* Null is accepted, but will be converted to a blank string.
* @param fieldNameValueSeparator the new field name value separator text
*/
protected void setFieldNameValueSeparator(String fieldNameValueSeparator) {
if (fieldNameValueSeparator == null) {
fieldNameValueSeparator = "";
}
this.fieldNameValueSeparator = fieldNameValueSeparator;
}
//---------------------------------------------------------------------
/**
* Gets the field separator text.
* @return the current field separator text
*/
protected String getFieldSeparator() {
return fieldSeparator;
}
/**
* Sets the field separator text.
* Null is accepted, but will be converted to a blank string.
* @param fieldSeparator the new field separator text
*/
protected void setFieldSeparator(String fieldSeparator) {
if (fieldSeparator == null) {
fieldSeparator = "";
}
this.fieldSeparator = fieldSeparator;
}
//---------------------------------------------------------------------
/**
* Gets the text to output when null found.
* @return the current text to output when null found
*/
protected String getNullText() {
return nullText;
}
/**
* Sets the text to output when null found.
* Null is accepted, but will be converted to a blank string.
* @param nullText the new text to output when null found
*/
protected void setNullText(String nullText) {
if (nullText == null) {
nullText = "";
}
this.nullText = nullText;
}
//---------------------------------------------------------------------
/**
* Gets the text to output when a Collection, Map or Array size is output.
* This is output before the size value.
* @return the current start of size text
*/
protected String getSizeStartText() {
return sizeStartText;
}
/**
* Sets the text to output when a Collection, Map or Array size is output.
* This is output before the size value.
* Null is accepted, but will be converted to a blank string.
* @param sizeStartText the new start of size text
*/
protected void setSizeStartText(String sizeStartText) {
if (sizeStartText == null) {
sizeStartText = "";
}
this.sizeStartText = sizeStartText;
}
//---------------------------------------------------------------------
/**
* Gets the text to output when a Collection, Map or Array size is output.
* This is output after the size value.
* @return the current end of size text
*/
protected String getSizeEndText() {
return sizeEndText;
}
/**
* Sets the text to output when a Collection, Map or Array size is output.
* This is output after the size value.
* Null is accepted, but will be converted to a blank string.
* @param sizeEndText the new end of size text
*/
protected void setSizeEndText(String sizeEndText) {
if (sizeEndText == null) {
sizeEndText = "";
}
this.sizeEndText = sizeEndText;
}
//---------------------------------------------------------------------
/**
* Gets the text to output when an Object is output in summary mode.
* This is output before the size value.
* @return the current start of summary text
*/
protected String getSummaryObjectStartText() {
return summaryObjectStartText;
}
/**
* Sets the text to output when an Object is output in summary mode.
* This is output before the size value.
* Null is accepted, but will be converted to a blank string.
* @param summaryObjectStartText the new start of summary text
*/
protected void setSummaryObjectStartText(String summaryObjectStartText) {
if (summaryObjectStartText == null) {
summaryObjectStartText = "";
}
this.summaryObjectStartText = summaryObjectStartText;
}
//---------------------------------------------------------------------
/**
* Gets the text to output when an Object is output in summary mode.
* This is output after the size value.
* @return the current end of summary text
*/
protected String getSummaryObjectEndText() {
return summaryObjectEndText;
}
/**
* Sets the text to output when an Object is output in summary mode.
* This is output after the size value.
* Null is accepted, but will be converted to a blank string.
* @param summaryObjectEndText the new end of summary text
*/
protected void setSummaryObjectEndText(String summaryObjectEndText) {
if (summaryObjectEndText == null) {
summaryObjectEndText = "";
}
this.summaryObjectEndText = summaryObjectEndText;
}
//---------------------------------------------------------------------
//----------------------------------------------------------------------------
/**
* Default ToStringStyle.
* This is an inner class rather than using StandardToStringStyle to
* ensure its immutability.
*/
private static final class DefaultToStringStyle extends ToStringStyle {
/**
* Constructor - use the static constant rather than instantiating.
*/
private DefaultToStringStyle() {
super();
}
/**
* Ensure singleton after serialization.
* @return the singleton
*/
private Object readResolve() {
return ToStringStyle.DEFAULT_STYLE;
}
}
//----------------------------------------------------------------------------
/**
* ToStringStyle that does not print out the field names.
* This is an inner class rather than using StandardToStringStyle to
* ensure its immutability.
*/
private static final class NoFieldNameToStringStyle extends ToStringStyle {
/**
* Constructor - use the static constant rather than instantiating.
*/
private NoFieldNameToStringStyle() {
super();
this.setUseFieldNames(false);
}
/**
* Ensure singleton after serialization.
* @return the singleton
*/
private Object readResolve() {
return ToStringStyle.NO_FIELD_NAMES_STYLE;
}
}
//----------------------------------------------------------------------------
/**
* ToStringStyle that does not print out the classname, identity hashcode,
* content start or field name.
* This is an inner class rather than using StandardToStringStyle to
* ensure its immutability.
*/
private static final class SimpleToStringStyle extends ToStringStyle {
/**
* Constructor - use the static constant rather than instantiating.
*/
private SimpleToStringStyle() {
super();
this.setUseClassName(false);
this.setUseIdentityHashCode(false);
this.setUseFieldNames(false);
this.setContentStart("");
this.setContentEnd("");
}
/**
* Ensure singleton after serialization.
* @return the singleton
*/
private Object readResolve() {
return ToStringStyle.SIMPLE_STYLE;
}
}
//----------------------------------------------------------------------------
/**
* ToStringStyle that outputs on multiple lines.
* This is an inner class rather than using StandardToStringStyle to
* ensure its immutability.
*/
private static final class MultiLineToStringStyle extends ToStringStyle {
/**
* Constructor - use the static constant rather than instantiating.
*/
private MultiLineToStringStyle() {
super();
this.setContentStart("[" + SystemUtils.LINE_SEPARATOR + " ");
this.setFieldSeparator(SystemUtils.LINE_SEPARATOR + " ");
this.setContentEnd(SystemUtils.LINE_SEPARATOR + "]");
}
/**
* Ensure singleton after serialization.
* @return the singleton
*/
private Object readResolve() {
return ToStringStyle.MULTI_LINE_STYLE;
}
}
//----------------------------------------------------------------------------
// Removed, as the XML style needs more work for escaping characters, arrays,
// collections, maps and embedded beans.
// /**
// * ToStringStyle that outputs in XML style
// */
// private static class XMLToStringStyle extends ToStringStyle {
//
// /**
// * Constructor - use the static constant rather than instantiating.
// */
// private XMLToStringStyle() {
// super();
// nullText = "null";
// sizeStartText = "size=";
// sizeEndText = "";
// }
//
// /**
// * @see ToStringStyle#appendStart(StringBuffer, Object)
// */
// public void appendStart(StringBuffer buffer, Object object) {
// buffer.append('<');
// buffer.append(getShortClassName(object.getClass()));
// buffer.append(" class=\"");
// appendClassName(buffer, object);
// buffer.append("\" hashCode=\"");
// appendIdentityHashCode(buffer, object);
// buffer.append("\">");
// buffer.append(SystemUtils.LINE_SEPARATOR);
// buffer.append(" ");
// }
//
// /**
// * @see ToStringStyle#appendFieldStart(StringBuffer, String)
// */
// protected void appendFieldStart(StringBuffer buffer, String fieldName) {
// buffer.append('<');
// buffer.append(fieldName);
// buffer.append('>');
// }
//
// /**
// * @see ToStringStyle#appendFieldEnd(StringBuffer, String)
// */
// protected void appendFieldEnd(StringBuffer buffer, String fieldName) {
// buffer.append("</");
// buffer.append(fieldName);
// buffer.append('>');
// buffer.append(SystemUtils.LINE_SEPARATOR);
// buffer.append(" ");
// }
//
// /**
// * @see ToStringStyle#appendEnd(StringBuffer, Object)
// */
// public void appendEnd(StringBuffer buffer, Object object) {
// int len = buffer.length();
// if (len > 2 && buffer.charAt(len - 1) == ' ' && buffer.charAt(len - 2) == ' ') {
// buffer.setLength(len - 2);
// }
// buffer.append("</");
// buffer.append(getShortClassName(object.getClass()));
// buffer.append("\">");
// }
//
// }
}
⏎ org/apache/commons/lang/builder/ToStringStyle.java
⇒ Using commons-lang3.jar in Java Programs
⇐ commons-lang-2.6.jar - Apache Commons Lang
2017-04-15, 18757👍, 0💬
Related Topics: