org.apache.commons.lang.builder.StandardToStringStyle Maven / Gradle / Ivy
Show all versions of commons-lang Show documentation
/*
* 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.lang.builder;
/**
* Works with {@link ToStringBuilder} to create a toString.
*
* This class is intended to be used as a singleton.
* There is no need to instantiate a new style each time.
* Simply instantiate the class once, customize the values as required, and
* store the result in a public static final variable for the rest of the
* program to access.
*
* @author Stephen Colebourne
* @author Pete Gieser
* @author Gary Gregory
* @since 1.0
* @version $Id: StandardToStringStyle.java 437554 2006-08-28 06:21:41Z bayard $
*/
public class StandardToStringStyle extends ToStringStyle {
/**
* Required for serialization support.
*
* @see java.io.Serializable
*/
private static final long serialVersionUID = 1L;
/**
* Constructor.
*/
public StandardToStringStyle() {
super();
}
//---------------------------------------------------------------------
/**
* Gets whether to use the class name.
*
* @return the current useClassName flag
*/
public boolean isUseClassName() {
return super.isUseClassName();
}
/**
* Sets whether to use the class name.
*
* @param useClassName the new useClassName flag
*/
public void setUseClassName(boolean useClassName) {
super.setUseClassName(useClassName);
}
//---------------------------------------------------------------------
/**
* Gets whether to output short or long class names.
*
* @return the current useShortClassName flag
* @since 2.0
*/
public boolean isUseShortClassName() {
return super.isUseShortClassName();
}
/**
* Gets whether to output short or long class names.
*
* @return the current shortClassName flag
* @deprecated Use {@link #isUseShortClassName()}
* Method will be removed in Commons Lang 3.0.
*/
public boolean isShortClassName() {
return super.isUseShortClassName();
}
/**
* Sets whether to output short or long class names.
*
* @param useShortClassName the new useShortClassName flag
* @since 2.0
*/
public void setUseShortClassName(boolean useShortClassName) {
super.setUseShortClassName(useShortClassName);
}
/**
* Sets whether to output short or long class names.
*
* @param shortClassName the new shortClassName flag
* @deprecated Use {@link #setUseShortClassName(boolean)}
* Method will be removed in Commons Lang 3.0.
*/
public void setShortClassName(boolean shortClassName) {
super.setUseShortClassName(shortClassName);
}
//---------------------------------------------------------------------
/**
* Gets whether to use the identity hash code.
* @return the current useIdentityHashCode flag
*/
public boolean isUseIdentityHashCode() {
return super.isUseIdentityHashCode();
}
/**
* Sets whether to use the identity hash code.
*
* @param useIdentityHashCode the new useIdentityHashCode flag
*/
public void setUseIdentityHashCode(boolean useIdentityHashCode) {
super.setUseIdentityHashCode(useIdentityHashCode);
}
//---------------------------------------------------------------------
/**
* Gets whether to use the field names passed in.
*
* @return the current useFieldNames flag
*/
public boolean isUseFieldNames() {
return super.isUseFieldNames();
}
/**
* Sets whether to use the field names passed in.
*
* @param useFieldNames the new useFieldNames flag
*/
public void setUseFieldNames(boolean useFieldNames) {
super.setUseFieldNames(useFieldNames);
}
//---------------------------------------------------------------------
/**
* Gets whether to use full detail when the caller doesn't
* specify.
*
* @return the current defaultFullDetail flag
*/
public boolean isDefaultFullDetail() {
return super.isDefaultFullDetail();
}
/**
* Sets whether to use full detail when the caller doesn't
* specify.
*
* @param defaultFullDetail the new defaultFullDetail flag
*/
public void setDefaultFullDetail(boolean defaultFullDetail) {
super.setDefaultFullDetail(defaultFullDetail);
}
//---------------------------------------------------------------------
/**
* Gets whether to output array content detail.
*
* @return the current array content detail setting
*/
public boolean isArrayContentDetail() {
return super.isArrayContentDetail();
}
/**
* Sets whether to output array content detail.
*
* @param arrayContentDetail the new arrayContentDetail flag
*/
public void setArrayContentDetail(boolean arrayContentDetail) {
super.setArrayContentDetail(arrayContentDetail);
}
//---------------------------------------------------------------------
/**
* Gets the array start text.
*
* @return the current array start text
*/
public String getArrayStart() {
return super.getArrayStart();
}
/**
* Sets the array start text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param arrayStart the new array start text
*/
public void setArrayStart(String arrayStart) {
super.setArrayStart(arrayStart);
}
//---------------------------------------------------------------------
/**
* Gets the array end text.
*
* @return the current array end text
*/
public String getArrayEnd() {
return super.getArrayEnd();
}
/**
* Sets the array end text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param arrayEnd the new array end text
*/
public void setArrayEnd(String arrayEnd) {
super.setArrayEnd(arrayEnd);
}
//---------------------------------------------------------------------
/**
* Gets the array separator text.
*
* @return the current array separator text
*/
public String getArraySeparator() {
return super.getArraySeparator();
}
/**
* Sets the array separator text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param arraySeparator the new array separator text
*/
public void setArraySeparator(String arraySeparator) {
super.setArraySeparator(arraySeparator);
}
//---------------------------------------------------------------------
/**
* Gets the content start text.
*
* @return the current content start text
*/
public String getContentStart() {
return super.getContentStart();
}
/**
* Sets the content start text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param contentStart the new content start text
*/
public void setContentStart(String contentStart) {
super.setContentStart(contentStart);
}
//---------------------------------------------------------------------
/**
* Gets the content end text.
*
* @return the current content end text
*/
public String getContentEnd() {
return super.getContentEnd();
}
/**
* Sets the content end text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param contentEnd the new content end text
*/
public void setContentEnd(String contentEnd) {
super.setContentEnd(contentEnd);
}
//---------------------------------------------------------------------
/**
* Gets the field name value separator text.
*
* @return the current field name value separator text
*/
public String getFieldNameValueSeparator() {
return super.getFieldNameValueSeparator();
}
/**
* Sets the field name value separator text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param fieldNameValueSeparator the new field name value separator text
*/
public void setFieldNameValueSeparator(String fieldNameValueSeparator) {
super.setFieldNameValueSeparator(fieldNameValueSeparator);
}
//---------------------------------------------------------------------
/**
* Gets the field separator text.
*
* @return the current field separator text
*/
public String getFieldSeparator() {
return super.getFieldSeparator();
}
/**
* Sets the field separator text.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param fieldSeparator the new field separator text
*/
public void setFieldSeparator(String fieldSeparator) {
super.setFieldSeparator(fieldSeparator);
}
//---------------------------------------------------------------------
/**
* Gets whether the field separator should be added at the start
* of each buffer.
*
* @return the fieldSeparatorAtStart flag
* @since 2.0
*/
public boolean isFieldSeparatorAtStart() {
return super.isFieldSeparatorAtStart();
}
/**
* Sets whether the field separator should be added at the start
* of each buffer.
*
* @param fieldSeparatorAtStart the fieldSeparatorAtStart flag
* @since 2.0
*/
public void setFieldSeparatorAtStart(boolean fieldSeparatorAtStart) {
super.setFieldSeparatorAtStart(fieldSeparatorAtStart);
}
//---------------------------------------------------------------------
/**
* Gets whether the field separator should be added at the end
* of each buffer.
*
* @return fieldSeparatorAtEnd flag
* @since 2.0
*/
public boolean isFieldSeparatorAtEnd() {
return super.isFieldSeparatorAtEnd();
}
/**
* Sets whether the field separator should be added at the end
* of each buffer.
*
* @param fieldSeparatorAtEnd the fieldSeparatorAtEnd flag
* @since 2.0
*/
public void setFieldSeparatorAtEnd(boolean fieldSeparatorAtEnd) {
super.setFieldSeparatorAtEnd(fieldSeparatorAtEnd);
}
//---------------------------------------------------------------------
/**
* Gets the text to output when null found.
*
* @return the current text to output when null found
*/
public String getNullText() {
return super.getNullText();
}
/**
* Sets the text to output when null found.
*
* null is accepted, but will be converted
* to an empty String.
*
* @param nullText the new text to output when null found
*/
public void setNullText(String nullText) {
super.setNullText(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
*/
public String getSizeStartText() {
return super.getSizeStartText();
}
/**
* Sets the start 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
* an empty String.
*
* @param sizeStartText the new start of size text
*/
public void setSizeStartText(String sizeStartText) {
super.setSizeStartText(sizeStartText);
}
//---------------------------------------------------------------------
/**
* Gets the end 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
*/
public String getSizeEndText() {
return super.getSizeEndText();
}
/**
* Sets the end 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 an empty String.
*
* @param sizeEndText the new end of size text
*/
public void setSizeEndText(String sizeEndText) {
super.setSizeEndText(sizeEndText);
}
//---------------------------------------------------------------------
/**
* Gets the start 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
*/
public String getSummaryObjectStartText() {
return super.getSummaryObjectStartText();
}
/**
* Sets the start 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
* an empty String.
*
* @param summaryObjectStartText the new start of summary text
*/
public void setSummaryObjectStartText(String summaryObjectStartText) {
super.setSummaryObjectStartText(summaryObjectStartText);
}
//---------------------------------------------------------------------
/**
* Gets the end 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
*/
public String getSummaryObjectEndText() {
return super.getSummaryObjectEndText();
}
/**
* Sets the end 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
* an empty String.
*
* @param summaryObjectEndText the new end of summary text
*/
public void setSummaryObjectEndText(String summaryObjectEndText) {
super.setSummaryObjectEndText(summaryObjectEndText);
}
//---------------------------------------------------------------------
}