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

Javadoc fixes and enhancements 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137071 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2002-09-28 10:44:51 +00:00
parent 031ff96cd3
commit 58299f3405
2 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/java/org/apache/commons/lang/builder/CompareToBuilder.java
View File

@ -99,7 +99,7 @@ import org.apache.commons.lang.NumberUtils;
* </pre>
* @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a>
* @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
* @version $Id: CompareToBuilder.java,v 1.3 2002/09/22 09:18:32 scolebourne Exp $
* @version $Id: CompareToBuilder.java,v 1.4 2002/09/28 10:44:51 scolebourne Exp $
*/
public class CompareToBuilder {
/**
@ -131,9 +131,10 @@ public class CompareToBuilder {
* Static fields will not be tested.
* @param lhs Left Hand Side
* @param rhs Right Hand Side
* @return int a negative integer, zero, or a positive integer as this
* @return a negative integer, zero, or a positive integer as this
* object is less than, equal to, or greater than the specified object.
* @throws ClassCastException - if the specified object's type prevents it
* @throws NullPointerException if either (but not both) parameter is null
* @throws ClassCastException if the specified object's type prevents it
* from being compared to this Object.
*/
public static int reflectionCompare(Object lhs, Object rhs) {
@ -155,9 +156,10 @@ public class CompareToBuilder {
* @param lhs Left Hand Side
* @param rhs Right Hand Side
* @param testTransients whether to include transient fields
* @return int - a negative integer, zero, or a positive integer as this
* @return a negative integer, zero, or a positive integer as this
* object is less than, equal to, or greater than the specified object.
* @throws ClassCastException - if the specified object's type prevents it
* @throws NullPointerException if either (but not both) parameter is null
* @throws ClassCastException if the specified object's type prevents it
* from being compared to this Object.
*/
public static int reflectionCompare(Object lhs, Object rhs,
@ -203,7 +205,8 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws ClassCastException - if the specified object's type prevents it
* @throws NullPointerException if either (but not both) parameter is null
* @throws ClassCastException if the specified object's type prevents it
* from being compared to this Object.
*/
public CompareToBuilder append(Object lhs, Object rhs) {
@ -379,7 +382,8 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws ClassCastException - if the specified object's type prevents it
* @throws NullPointerException if either (but not both) parameter is null
* @throws ClassCastException if the specified object's type prevents it
* from being compared to this Object.
*/
public CompareToBuilder append(Object[] lhs, Object[] rhs) {
@ -413,6 +417,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(long[] lhs, long[] rhs) {
if (comparison != 0) {
@ -440,6 +445,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(int[] lhs, int[] rhs) {
if (comparison != 0) {
@ -467,6 +473,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(short[] lhs, short[] rhs) {
if (comparison != 0) {
@ -494,6 +501,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(char[] lhs, char[] rhs) {
if (comparison != 0) {
@ -521,6 +529,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(byte[] lhs, byte[] rhs) {
if (comparison != 0) {
@ -548,6 +557,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(double[] lhs, double[] rhs) {
if (comparison != 0) {
@ -575,6 +585,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(float[] lhs, float[] rhs) {
if (comparison != 0) {
@ -602,6 +613,7 @@ public class CompareToBuilder {
* @param lhs - Left Hand Side
* @param rhs - Right Hand Side
* @return CompareToBuilder - used to chain calls.
* @throws NullPointerException if either (but not both) parameter is null
*/
public CompareToBuilder append(boolean[] lhs, boolean[] rhs) {
if (comparison != 0) {

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

@ -93,7 +93,7 @@ import java.lang.reflect.Modifier;
* passed into the constructor.
*
* @author <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a>
* @version $Id: ToStringBuilder.java,v 1.3 2002/09/22 09:18:32 scolebourne Exp $
* @version $Id: ToStringBuilder.java,v 1.4 2002/09/28 10:44:51 scolebourne Exp $
*/
public class ToStringBuilder {
@ -156,7 +156,7 @@ public class ToStringBuilder {
throw new IllegalArgumentException("The object to create a toString for must not be null");
}
if (style == null) {
style = ToStringStyle.DEFAULT_STYLE;
style = getDefaultStyle();
}
if (buffer == null) {
buffer = new StringBuffer(512);
@ -257,7 +257,7 @@ public class ToStringBuilder {
* @param style the style of the toString to create, may be null
* @param outputTransients whether to include transient fields
* @return the String result
* @throws IllegalArgumentException if the object or style is null
* @throws IllegalArgumentException if the object is null
*/
public static String reflectionToString(Object object, ToStringStyle style,
boolean outputTransients) {