org.jvnet.jaxb2_commons.lang.DefaultToStringStrategy Maven / Gradle / Ivy
package org.jvnet.jaxb2_commons.lang;
import static org.jvnet.jaxb2_commons.locator.util.LocatorUtils.item;
import static org.jvnet.jaxb2_commons.locator.util.LocatorUtils.property;
import java.util.Collection;
import org.jvnet.jaxb2_commons.locator.ObjectLocator;
public class DefaultToStringStrategy implements ToStringStrategy {
/**
* Whether to use the field names, the default is true.
*/
private boolean useFieldNames = true;
/**
* Whether to use the class name, the default is true.
*/
private boolean useClassName = true;
/**
* Whether to use short class names, the default is false.
*/
private boolean useShortClassName = false;
/**
* Whether to use the identity hash code, the default is 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 = "=";
/**
* Whether the field separator should be added before any other fields.
*/
private boolean fieldSeparatorAtStart = false;
/**
* Whether the field separator should be added after any other fields.
*/
private boolean fieldSeparatorAtEnd = false;
/**
* The field separator ','.
*/
private String fieldSeparator = ", ";
/**
* The array start '{'.
*/
private String arrayStart = "{";
/**
* The array separator ','.
*/
private String arraySeparator = ",";
/**
* The array end '}'.
*/
private String arrayEnd = "}";
/**
* The value to use when fullDetail is null, the default value
* is true.
*/
private boolean fullDetail = true;
/**
* The null text '<null>'.
*/
private String nullText = "";
/**
* The summary size text start '.
*/
private String sizeStartText = "'>' .
*/
private String sizeEndText = ">";
public boolean isFullDetail() {
return fullDetail;
}
public boolean isUseIdentityHashCode() {
return useIdentityHashCode;
}
@SuppressWarnings("unchecked")
protected String getShortClassName(Class cls) {
return ClassUtils.getShortClassName(cls);
}
/**
*
* Append to the toString the class name.
*
*
* @param buffer
* the StringBuilder to populate
* @param object
* the Object whose name to output
*/
protected void appendClassName(StringBuilder buffer, Object object) {
if (useClassName && object != null) {
if (useShortClassName) {
buffer.append(getShortClassName(object.getClass()));
} else {
buffer.append(object.getClass().getName());
}
}
}
/**
*
* Append the {@link System#identityHashCode(java.lang.Object)}.
*
*
* @param buffer
* the StringBuilder to populate
* @param object
* the Object whose id to output
*/
protected void appendIdentityHashCode(StringBuilder buffer, Object object) {
if (this.isUseIdentityHashCode() && object != null) {
buffer.append('@');
buffer.append(Integer.toHexString(System.identityHashCode(object)));
}
}
/**
*
* Append to the toString the content start.
*
*
* @param buffer
* the StringBuilder to populate
*/
protected void appendContentStart(StringBuilder buffer) {
buffer.append(contentStart);
}
/**
*
* Append to the toString the content end.
*
*
* @param buffer
* the StringBuilder to populate
*/
protected void appendContentEnd(StringBuilder buffer) {
buffer.append(contentEnd);
}
protected void appendArrayStart(StringBuilder buffer) {
buffer.append(arrayStart);
}
protected void appendArrayEnd(StringBuilder buffer) {
buffer.append(arrayEnd);
}
protected void appendArraySeparator(StringBuilder buffer) {
buffer.append(arraySeparator);
}
/**
*
* Append to the toString an indicator for null.
*
*
*
* The default indicator is '<null>'.
*
*
* @param buffer
* the StringBuilder to populate
*/
protected void appendNullText(StringBuilder buffer) {
buffer.append(nullText);
}
/**
*
* Append to the toString the field start.
*
*
* @param buffer
* the StringBuilder to populate
* @param propertyName
* the field name
*/
protected void appendFieldStart(ObjectLocator parentLocator, Object parent,
String fieldName, StringBuilder buffer) {
if (useFieldNames && fieldName != null) {
buffer.append(fieldName);
buffer.append(fieldNameValueSeparator);
}
}
/**
*
* Append to the toString the field end.
*
*
* @param buffer
* the StringBuilder to populate
* @param propertyName
* the field name, typically not used as already appended
*/
protected void appendFieldEnd(ObjectLocator parentLocator, Object parent,
String fieldName, StringBuilder buffer) {
appendFieldSeparator(buffer);
}
/**
*
* Append to the toString the field separator.
*
*
* @param buffer
* the StringBuilder to populate
*/
protected void appendFieldSeparator(StringBuilder buffer) {
buffer.append(fieldSeparator);
}
/**
*
* Append to the toString a size summary.
*
*
*
* The size summary is used to summarize the contents of
* Collections, Maps and arrays.
*
*
*
* The output consists of a prefix, the passed in size and a suffix.
*
*
*
* The default format is '<size=n>'.
*
*
* @param buffer
* the StringBuilder to populate
* @param propertyName
* the field name, typically not used as already appended
* @param size
* the size to append
*/
protected void appendSummarySize(ObjectLocator locator,
StringBuilder buffer, int size) {
buffer.append(sizeStartText);
buffer.append(size);
buffer.append(sizeEndText);
}
public StringBuilder appendStart(ObjectLocator parentLocator,
Object object, StringBuilder buffer) {
if (object != null) {
appendClassName(buffer, object);
appendIdentityHashCode(buffer, object);
appendContentStart(buffer);
if (fieldSeparatorAtStart) {
appendFieldSeparator(buffer);
}
}
return buffer;
}
public StringBuilder appendEnd(ObjectLocator parentLocator, Object parent,
StringBuilder buffer) {
if (this.fieldSeparatorAtEnd == false) {
removeLastFieldSeparator(buffer);
}
appendContentEnd(buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, Object value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, boolean value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, byte value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, char value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, double value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, float value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, long value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, int value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, short value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer,
Object[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
@SuppressWarnings("unchecked")
public StringBuilder append(ObjectLocator parentLocator, Object parent,
String fieldName, StringBuilder buffer, Collection value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer,
boolean[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, byte[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, char[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer,
double[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, float[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, long[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, int[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
public StringBuilder appendField(ObjectLocator parentLocator,
Object parent, String fieldName, StringBuilder buffer, short[] value) {
appendFieldStart(parentLocator, parent, fieldName, buffer);
append(property(parentLocator, fieldName, value), buffer, value);
appendFieldEnd(parentLocator, parent, fieldName, buffer);
return buffer;
}
@SuppressWarnings("unchecked")
protected StringBuilder appendInternal(ObjectLocator locator,
StringBuilder buffer, Object value) {
if (value instanceof Collection) {
append(locator, buffer, (Collection) value);
} else if (value instanceof ToString) {
((ToString) value).append(locator, buffer, this);
} else {
buffer.append(value.toString());
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
Object value) {
if (value == null) {
appendNullText(buffer);
} else {
Class theClass = value.getClass();
if (!theClass.isArray()) {
appendInternal(locator, buffer, value);
}
// 'Switch' on type of array, to dispatch to the correct handler
// This handles multi dimensional arrays of the same depth
else if (value instanceof long[]) {
append(locator, buffer, (long[]) value);
} else if (value instanceof int[]) {
append(locator, buffer, (int[]) value);
} else if (value instanceof short[]) {
append(locator, buffer, (short[]) value);
} else if (value instanceof char[]) {
append(locator, buffer, (char[]) value);
} else if (value instanceof byte[]) {
append(locator, buffer, (byte[]) value);
} else if (value instanceof double[]) {
append(locator, buffer, (double[]) value);
} else if (value instanceof float[]) {
append(locator, buffer, (float[]) value);
} else if (value instanceof boolean[]) {
append(locator, buffer, (boolean[]) value);
} else {
// Not an array of primitives
append(locator, buffer, (Object[]) value);
}
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
boolean value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
byte value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
char value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
double value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
float value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
int value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
long value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
short value) {
buffer.append(value);
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
Object[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
@SuppressWarnings("unchecked")
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
Collection array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
boolean[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
byte[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
char[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
double[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
float[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
int[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
long[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
public StringBuilder append(ObjectLocator locator, StringBuilder buffer,
short[] array) {
if (array == null) {
appendNullText(buffer);
} else if (isFullDetail()) {
appendDetail(locator, buffer, array);
} else {
appendSummary(locator, buffer, array);
}
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, boolean[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, byte[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, char[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, double[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, float[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, int[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, long[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, short[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, Object[] array) {
appendSummarySize(locator, buffer, array.length);
return buffer;
}
@SuppressWarnings("unchecked")
protected StringBuilder appendSummary(ObjectLocator locator,
StringBuilder buffer, Collection value) {
appendSummarySize(locator, buffer, value.size());
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, boolean[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, byte[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, char[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, double[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, float[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, int[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, long[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, short[] array) {
buffer.append(arrayStart);
for (int i = 0; i < array.length; i++) {
if (i > 0) {
buffer.append(arraySeparator);
}
append(item(locator, i, array[i]), buffer, array[i]);
}
buffer.append(arrayEnd);
return buffer;
}
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, 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);
} else {
append(item(locator, i, array[i]), buffer, array[i]);
}
}
buffer.append(arrayEnd);
return buffer;
}
@SuppressWarnings("unchecked")
protected StringBuilder appendDetail(ObjectLocator locator,
StringBuilder buffer, Collection array) {
appendArrayStart(buffer);
int i = 0;
for (Object item : array) {
if (i > 0) {
appendArraySeparator(buffer);
}
append(item(locator, i, item), buffer, item);
i = i + 1;
}
appendArrayEnd(buffer);
return buffer;
}
/**
*
* Remove the last field separator from the buffer.
*
*
* @param buffer
* the StringBuilder to populate
* @since 2.0
*/
protected void removeLastFieldSeparator(StringBuilder buffer) {
int len = buffer.length();
int sepLen = fieldSeparator.length();
if (len > 0 && sepLen > 0 && len >= sepLen) {
boolean match = true;
for (int i = 0; i < sepLen; i++) {
if (buffer.charAt(len - 1 - i) != fieldSeparator.charAt(sepLen
- 1 - i)) {
match = false;
break;
}
}
if (match) {
buffer.setLength(len - sepLen);
}
}
}
public static final ToStringStrategy INSTANCE = new DefaultToStringStrategy();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy