Applying Scott Bassin's patch from LANG-371 - improving the documentation for ToStringStyle as per Paul's report

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@591559 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Henri Yandell 2007-11-03 08:03:33 +00:00
parent 08e3868ddd
commit 157ae91e13
1 changed files with 36 additions and 5 deletions

View File

@ -71,28 +71,59 @@ import org.apache.commons.lang.SystemUtils;
public abstract class ToStringStyle implements Serializable { public abstract class ToStringStyle implements Serializable {
/** /**
* The default toString style. * The default toString style. Using the Using the <code>Person</code>
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
* Person@182f0db[name=John Doe,age=33,smoker=false]
* </pre>
*/ */
public static final ToStringStyle DEFAULT_STYLE = new DefaultToStringStyle(); public static final ToStringStyle DEFAULT_STYLE = new DefaultToStringStyle();
/** /**
* The multi line toString style. * The multi line toString style. Using the Using the <code>Person</code>
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
* Person@182f0db[
* name=John Doe
* age=33
* smoker=false
* ]
* </pre>
*/ */
public static final ToStringStyle MULTI_LINE_STYLE = new MultiLineToStringStyle(); public static final ToStringStyle MULTI_LINE_STYLE = new MultiLineToStringStyle();
/** /**
* The no field names toString style. * The no field names toString style. Using the Using the
* <code>Person</code> example from {@link ToStringBuilder}, the output
* would look like this:
*
* <pre>
* Person@182f0db[John Doe,33,false]
* </pre>
*/ */
public static final ToStringStyle NO_FIELD_NAMES_STYLE = new NoFieldNameToStringStyle(); public static final ToStringStyle NO_FIELD_NAMES_STYLE = new NoFieldNameToStringStyle();
/** /**
* The short prefix toString style. * The short prefix toString style. Using the <code>Person</code> example
* from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
* Person[name=John Doe,age=33,smoker=false]
* </pre>
*
* @since 2.1 * @since 2.1
*/ */
public static final ToStringStyle SHORT_PREFIX_STYLE = new ShortPrefixToStringStyle(); public static final ToStringStyle SHORT_PREFIX_STYLE = new ShortPrefixToStringStyle();
/** /**
* The simple toString style. * The simple toString style. Using the Using the <code>Person</code>
* example from {@link ToStringBuilder}, the output would look like this:
*
* <pre>
* John Doe,33,false
* </pre>
*/ */
public static final ToStringStyle SIMPLE_STYLE = new SimpleToStringStyle(); public static final ToStringStyle SIMPLE_STYLE = new SimpleToStringStyle();