Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Javadoc (I hope!). 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137284 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2003-04-08 22:36:04 +00:00
parent e180daa748
commit 6a1dc2997c
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/java/org/apache/commons/lang/builder/ToStringBuilder.java
View File

@ -59,16 +59,17 @@ import java.util.HashSet;
import java.util.Set; 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 * <p>This class enables a good and consistent <code>toString()</code> to be built for any
* class. This class aims to simplify the process by:</p> * class or object. This class aims to simplify the process by:</p>
* <ul> * <ul>
* <li>allowing field names * <li>allowing field names
* <li>handling all types consistently * <li>handling all types consistently
* <li>handling nulls consistently * <li>handling nulls consistently
* <li>outputting arrays and multi-dimensional arrays * <li>outputting arrays and multi-dimensional arrays
* <li>enabling the detail level to be controlled for Objects and Collections * <li>enabling the detail level to be controlled for Objects and Collections
* <li>handling class hierarchies
* </ul> * </ul>
* *
* <p>To use this class write code as follows: * <p>To use this class write code as follows:
@ -110,13 +111,18 @@ import java.util.Set;
* } * }
* </pre> * </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 * <p>The exact format of the <code>toString</code> is determined by
* the {@link ToStringStyle} passed into the constructor.</p> * the {@link ToStringStyle} passed into the constructor.</p>
* *
* @author Stephen Colebourne * @author Stephen Colebourne
* @author Gary Gregory * @author Gary Gregory
* @since 1.0 * @since 1.0
* @version $Id: ToStringBuilder.java,v 1.18 2003/04/08 20:44:10 ggregory Exp $ * @version $Id: ToStringBuilder.java,v 1.19 2003/04/08 22:35:40 ggregory Exp $
*/ */
public class ToStringBuilder { public class ToStringBuilder {

4
src/java/org/apache/commons/lang/builder/package.html
View File

@ -1,6 +1,6 @@
<html> <html>
<body> <body>
These builders assist with creating good equals(), toString(), hashCode(), These builders assist with creating good and consistent <code>equals()</code>, <code>toString()</code>,
and compareTo() methods. <code>hashCode()</code>, and <code>compareTo()</code> methods.
</body> </body>
</html> </html>

2
src/java/org/apache/commons/lang/package.html
View File

@ -1,6 +1,6 @@
<html> <html>
<body> <body>
A collection of highly reusable static utility methods, chiefly concerned A collection of highly reusable static utility methods, chiefly concerned
with adding value to java.lang and other standard core classes. with adding value to <code>java.lang</code> and other standard core classes.
</body> </body>
</html> </html>