Author: niallp
Date: Fri Jan 22 10:52:07 2010
New Revision: 902053
URL: http://svn.apache.org/viewvc?rev=902053&view=rev
Log:
Javadoc updates only
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ClassUtils.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/EnumUtils.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Range.java
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java?rev=902053&r1=902052&r2=902053&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/CharRange.java
Fri Jan 22 10:52:07 2010
@@ -79,6 +79,7 @@
* <p>Constructs a <code>CharRange</code> over a single character.</p>
*
* @param ch only character in this range
+ * @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean)
*/
public static CharRange is(char ch) {
@@ -89,6 +90,7 @@
* <p>Constructs a negated <code>CharRange</code> over a single
character.</p>
*
* @param ch only character in this range
+ * @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean)
*/
public static CharRange isNot(char ch) {
@@ -100,6 +102,7 @@
*
* @param start first character, inclusive, in this range
* @param end last character, inclusive, in this range
+ * @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean)
*/
public static CharRange isIn(char start, char end) {
@@ -111,6 +114,7 @@
*
* @param start first character, inclusive, in this range
* @param end last character, inclusive, in this range
+ * @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean)
*/
public static CharRange isNotIn(char start, char end) {
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ClassUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ClassUtils.java?rev=902053&r1=902052&r2=902053&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ClassUtils.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/ClassUtils.java
Fri Jan 22 10:52:07 2010
@@ -321,6 +321,12 @@
return new ArrayList<Class<?>>(interfacesFound);
}
+ /**
+ * Get the interfaces for the specified class.
+ *
+ * @param cls the class to look up, may be <code>null</code>
+ * @param interfacesFound the <code>Set</code> of interfaces for the class
+ */
private static void getAllInterfaces(Class<?> cls, HashSet<Class<?>>
interfacesFound) {
while (cls != null) {
Class<?>[] interfaces = cls.getInterfaces();
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/EnumUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/EnumUtils.java?rev=902053&r1=902052&r2=902053&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/EnumUtils.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/EnumUtils.java
Fri Jan 22 10:52:07 2010
@@ -71,7 +71,8 @@
* a valid enum without needing to catch the exception.
*
* @param enumClass the class of the <code>enum</code> to get, not null
- * @return the map of enum names to enums, never null
+ * @param enumName the enum name
+ * @return true if the enum name is valid, otherwise false
*/
public static <E extends Enum<E>> boolean isValidEnum(Class<E> enumClass,
String enumName) {
try {
@@ -89,7 +90,8 @@
* for an invalid enum name.
*
* @param enumClass the class of the <code>enum</code> to get, not null
- * @return the map of enum names to enums, never null
+ * @param enumName the enum name
+ * @return the enum or null if not found
*/
public static <E extends Enum<E>> E getEnum(Class<E> enumClass, String
enumName) {
try {
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Range.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Range.java?rev=902053&r1=902052&r2=902053&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Range.java
(original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Range.java
Fri Jan 22 10:52:07 2010
@@ -67,6 +67,7 @@
* determine where values lie in the range.</p>
*
* @param element the value to use for this range, must not be
<code>null</code>
+ * @return the new range object
* @throws IllegalArgumentException if the value is <code>null</code>
* @throws ClassCastException if the value is not Comparable
*/
@@ -85,6 +86,7 @@
*
* @param element1 first value that defines the edge of the range,
inclusive
* @param element2 second value that defines the edge of the range,
inclusive
+ * @return the new range object
* @throws IllegalArgumentException if either value is <code>null</code>
* @throws ClassCastException if either value is not Comparable
*/
@@ -100,6 +102,7 @@
*
* @param element the value to use for this range, must not be
<code>null</code>
* @param c comparator to be used
+ * @return the new range object
* @throws IllegalArgumentException if the value is <code>null</code>
*/
public static <T> Range<T> is(T element, Comparator<T> c) {
@@ -118,6 +121,7 @@
* @param element1 first value that defines the edge of the range,
inclusive
* @param element2 second value that defines the edge of the range,
inclusive
* @param c comparator to be used
+ * @return the new range object
* @throws IllegalArgumentException if either value is <code>null</code>
*/
public static <T> Range<T> between(T element1, T element2, Comparator<T>
c) {
