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 ToStringStyle.java HashCodeBuilder.java CompareToBuilder.java ReflectionToStringBuilder.java EqualsBuilder.java ToStringBuilder.java
Date Sat, 23 Aug 2003 00:21:49 GMT
ggregory    2003/08/22 17:21:49

  Modified:    lang/src/java/org/apache/commons/lang/builder
                        ToStringStyle.java HashCodeBuilder.java
                        CompareToBuilder.java
                        ReflectionToStringBuilder.java EqualsBuilder.java
                        ToStringBuilder.java
  Log:
  Class Javadoc: Normalize the first sentence and some @see's and {@link}s
  
  Revision  Changes    Path
  1.27      +3 -4      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ToStringStyle.java
  
  Index: ToStringStyle.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ToStringStyle.java,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  --- ToStringStyle.java	22 Aug 2003 03:06:36 -0000	1.26
  +++ ToStringStyle.java	23 Aug 2003 00:21:49 -0000	1.27
  @@ -63,9 +63,8 @@
   import org.apache.commons.lang.SystemUtils;
   
   /**
  - * <p><code>ToStringStyle</code> works with <code>ToStringBuilder</code>
  - * to create a <code>toString</code>. The main public interface is always
  - * via <code>ToStringBuilder</code>.</p>
  + * <p>Controls <code>String</code> formatting for {@link ToStringBuilder}.
  + * The main public interface is always via <code>ToStringBuilder</code>.</p>
    *
    * <p>These classes are intended to be used as <code>Singletons</code>.
    * There is no need to instantiate a new style each time. A program
  
  
  
  1.20      +2 -2      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/HashCodeBuilder.java
  
  Index: HashCodeBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/HashCodeBuilder.java,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- HashCodeBuilder.java	21 Aug 2003 15:52:54 -0000	1.19
  +++ HashCodeBuilder.java	23 Aug 2003 00:21:49 -0000	1.20
  @@ -58,7 +58,7 @@
   import java.lang.reflect.Modifier;
   
   /**
  - * <p><code>HashCode</code> generation routines.</p>
  + * <p>Assists in implementing {@link Object#hashCode()} methods.</p>
    *
    * <p> This class enables a good <code>hashCode</code> method to be built
for any class. It
    * follows the rules laid out in the book
  
  
  
  1.23      +9 -5      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/CompareToBuilder.java
  
  Index: CompareToBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/CompareToBuilder.java,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- CompareToBuilder.java	21 Aug 2003 15:13:09 -0000	1.22
  +++ CompareToBuilder.java	23 Aug 2003 00:21:49 -0000	1.23
  @@ -61,10 +61,9 @@
   import org.apache.commons.lang.math.NumberUtils;
   
   /** 
  - * <p><code>CompareTo</code> generation routines.</p>
  + * Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods.
    *
  - * <p>This class provides methods to assist in building a quality
  - * <code>compareTo(Object)</code>.  It is consistent with <code>equals(Object)</code>
and
  + * It is consistent with <code>equals(Object)</code> and
    * <code>hashcode()</code> built with {@link EqualsBuilder} and
    * {@link HashCodeBuilder}.</p>
    *
  @@ -100,7 +99,7 @@
    *
    * <p>Alternatively, there is a method {@link #reflectionCompare reflectionCompare}
that uses
    * reflection to determine the fields to append. Because fields can be private,
  - * <code>reflectionCompare</code> uses <code>AccessibleObject.setAccessible</code>
to
  + * <code>reflectionCompare</code> uses {@link java.lang.reflect.AccessibleObject#setAccessible(boolean)}
to
    * bypass normal access control checks. This will fail under a security manager,
    * unless the appropriate permissions are set up correctly. It is also
    * slower than appending explicitly.</p>
  @@ -114,6 +113,11 @@
    * }
    * </pre>
    *
  + * @see java.lang.Comparable
  + * @see java.lang.Object#equals(Object)
  + * @see java.lang.Object#hashCode()
  + * @see EqualsBuilder
  + * @see HashCodeBuilder
    * @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a>
    * @author Stephen Colebourne
    * @author Gary Gregory
  
  
  
  1.10      +3 -3      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ReflectionToStringBuilder.java
  
  Index: ReflectionToStringBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/ReflectionToStringBuilder.java,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- ReflectionToStringBuilder.java	18 Aug 2003 02:22:24 -0000	1.9
  +++ ReflectionToStringBuilder.java	23 Aug 2003 00:21:49 -0000	1.10
  @@ -62,7 +62,7 @@
   import org.apache.commons.lang.ClassUtils;
   
   /**
  - * <p>Builds <code>toString()</code> values using reflection.</p>
  + * <p>Assists in implementing {@link Object#toString()} methods using reflection.</p>
    *
    * <p>This class uses reflection to determine the fields to append. 
    * Because these fields are usually private, the class 
  @@ -100,7 +100,7 @@
    * <p>The exact format of the <code>toString</code> is determined by
    * the {@link ToStringStyle} passed into the constructor.</p>
    *
  - * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
  + * @author Gary Gregory
    * @author Stephen Colebourne
    * @author Pete Gieser
    * @since 2.0
  
  
  
  1.20      +2 -2      jakarta-commons/lang/src/java/org/apache/commons/lang/builder/EqualsBuilder.java
  
  Index: EqualsBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/builder/EqualsBuilder.java,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- EqualsBuilder.java	21 Aug 2003 15:52:54 -0000	1.19
  +++ EqualsBuilder.java	23 Aug 2003 00:21:49 -0000	1.20
  @@ -58,7 +58,7 @@
   import java.lang.reflect.Modifier;
   
   /**
  - * <p><code>Equals</code> generation routines.</p>
  + * <p>Assists in implementing {@link Object#equals(Object)} methods.</p>
    *
    * <p> This class provides methods to build a good equals method for any
    * class. It follows rules laid out in
  
  
  
  1.29      +2 -2      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.28
  retrieving revision 1.29
  diff -u -r1.28 -r1.29
  --- ToStringBuilder.java	21 Aug 2003 15:52:54 -0000	1.28
  +++ ToStringBuilder.java	23 Aug 2003 00:21:49 -0000	1.29
  @@ -57,7 +57,7 @@
   import org.apache.commons.lang.ObjectUtils;
   
   /**
  - * <p><code>ToString</code> generation routines.</p>
  + * <p>Assists in implementing {@link Object#toString()} methods.</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>
  
  
  

Mime
View raw message