commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang/builder ToStringBuilder.java
Date Tue, 08 Apr 2003 22:35:40 GMT
ggregory    2003/04/08 15:35:40

  Modified:    lang/src/java/org/apache/commons/lang/builder
                        ToStringBuilder.java
  Log:
  Improve Javadoc (I hope!).
  
  Revision  Changes    Path
  1.19      +10 -4     jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ToStringBuilder.java
  
  Index: ToStringBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ToStringBuilder.java,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- ToStringBuilder.java	8 Apr 2003 20:44:10 -0000	1.18
  +++ ToStringBuilder.java	8 Apr 2003 22:35:40 -0000	1.19
  @@ -59,16 +59,17 @@
   import java.util.Set;
   
   /**
  - * <p><code>ToString</code> generation routine.</p>
  + * <p><code>toString()</code> generation routines.</p>
    *
  - * <p>This class enables a good <code>toString</code> to be built for
any
  - * class. This class aims to simplify the process by:</p>
  + * <p>This class enables a good and consistent <code>toString()</code>
to be built for any
  + * class or object. This class aims to simplify the process by:</p>
    * <ul>
    * <li>allowing field names
    * <li>handling all types consistently
    * <li>handling nulls consistently
    * <li>outputting arrays and multi-dimensional arrays
    * <li>enabling the detail level to be controlled for Objects and Collections
  + * <li>handling class hierarchies
    * </ul>
    *
    * <p>To use this class write code as follows:
  @@ -110,6 +111,11 @@
    * }
    * </pre>
    *
  + * <p>You can also use the builder to debug 3rd party objects:</p>
  + * <pre>
  + * System.out.println("An object: " + ToStringBuilder.reflectionToString(anObject));
  + * </pre>
  + * 
    * <p>The exact format of the <code>toString</code> is determined by
    * the {@link ToStringStyle} passed into the constructor.</p>
    *
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message