You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2002/09/28 12:44:51 UTC
cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang/builder CompareToBuilder.java ToStringBuilder.java
scolebourne 2002/09/28 03:44:51
Modified: lang/src/java/org/apache/commons/lang/builder
CompareToBuilder.java ToStringBuilder.java
Log:
Javadoc fixes and enhancements
Revision Changes Path
1.4 +19 -7 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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- CompareToBuilder.java 22 Sep 2002 09:18:32 -0000 1.3
+++ CompareToBuilder.java 28 Sep 2002 10:44:51 -0000 1.4
@@ -131,9 +131,10 @@
* 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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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 @@
* @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) {
1.4 +3 -3 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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ToStringBuilder.java 22 Sep 2002 09:18:32 -0000 1.3
+++ ToStringBuilder.java 28 Sep 2002 10:44:51 -0000 1.4
@@ -156,7 +156,7 @@
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 @@
* @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) {
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>