Javadoc updates only

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@902053 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Niall Pemberton 2010-01-22 10:52:07 +00:00
parent 91e2b603a6
commit e5618bc494
4 changed files with 18 additions and 2 deletions

View File

@ -79,6 +79,7 @@ public final class CharRange implements Serializable {
* <p>Constructs a <code>CharRange</code> over a single character.</p> * <p>Constructs a <code>CharRange</code> over a single character.</p>
* *
* @param ch only character in this range * @param ch only character in this range
* @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean) * @see CharRange#CharRange(char, char, boolean)
*/ */
public static CharRange is(char ch) { public static CharRange is(char ch) {
@ -89,6 +90,7 @@ public final class CharRange implements Serializable {
* <p>Constructs a negated <code>CharRange</code> over a single character.</p> * <p>Constructs a negated <code>CharRange</code> over a single character.</p>
* *
* @param ch only character in this range * @param ch only character in this range
* @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean) * @see CharRange#CharRange(char, char, boolean)
*/ */
public static CharRange isNot(char ch) { public static CharRange isNot(char ch) {
@ -100,6 +102,7 @@ public final class CharRange implements Serializable {
* *
* @param start first character, inclusive, in this range * @param start first character, inclusive, in this range
* @param end last character, inclusive, in this range * @param end last character, inclusive, in this range
* @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean) * @see CharRange#CharRange(char, char, boolean)
*/ */
public static CharRange isIn(char start, char end) { public static CharRange isIn(char start, char end) {
@ -111,6 +114,7 @@ public final class CharRange implements Serializable {
* *
* @param start first character, inclusive, in this range * @param start first character, inclusive, in this range
* @param end last character, inclusive, in this range * @param end last character, inclusive, in this range
* @return the new CharRange object
* @see CharRange#CharRange(char, char, boolean) * @see CharRange#CharRange(char, char, boolean)
*/ */
public static CharRange isNotIn(char start, char end) { public static CharRange isNotIn(char start, char end) {

View File

@ -321,6 +321,12 @@ public class ClassUtils {
return new ArrayList<Class<?>>(interfacesFound); 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) { private static void getAllInterfaces(Class<?> cls, HashSet<Class<?>> interfacesFound) {
while (cls != null) { while (cls != null) {
Class<?>[] interfaces = cls.getInterfaces(); Class<?>[] interfaces = cls.getInterfaces();

View File

@ -71,7 +71,8 @@ public class EnumUtils {
* a valid enum without needing to catch the exception. * a valid enum without needing to catch the exception.
* *
* @param enumClass the class of the <code>enum</code> to get, not null * @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) { public static <E extends Enum<E>> boolean isValidEnum(Class<E> enumClass, String enumName) {
try { try {
@ -89,7 +90,8 @@ public class EnumUtils {
* for an invalid enum name. * for an invalid enum name.
* *
* @param enumClass the class of the <code>enum</code> to get, not null * @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) { public static <E extends Enum<E>> E getEnum(Class<E> enumClass, String enumName) {
try { try {

View File

@ -67,6 +67,7 @@ public final class Range<T> implements Serializable {
* determine where values lie in the range.</p> * determine where values lie in the range.</p>
* *
* @param element the value to use for this range, must not be <code>null</code> * @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 IllegalArgumentException if the value is <code>null</code>
* @throws ClassCastException if the value is not Comparable * @throws ClassCastException if the value is not Comparable
*/ */
@ -85,6 +86,7 @@ public final class Range<T> implements Serializable {
* *
* @param element1 first value that defines the edge of the range, inclusive * @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 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 IllegalArgumentException if either value is <code>null</code>
* @throws ClassCastException if either value is not Comparable * @throws ClassCastException if either value is not Comparable
*/ */
@ -100,6 +102,7 @@ public final class Range<T> implements Serializable {
* *
* @param element the value to use for this range, must not be <code>null</code> * @param element the value to use for this range, must not be <code>null</code>
* @param c comparator to be used * @param c comparator to be used
* @return the new range object
* @throws IllegalArgumentException if the value is <code>null</code> * @throws IllegalArgumentException if the value is <code>null</code>
*/ */
public static <T> Range<T> is(T element, Comparator<T> c) { public static <T> Range<T> is(T element, Comparator<T> c) {
@ -118,6 +121,7 @@ public final class Range<T> implements Serializable {
* @param element1 first value that defines the edge of the range, inclusive * @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 element2 second value that defines the edge of the range, inclusive
* @param c comparator to be used * @param c comparator to be used
* @return the new range object
* @throws IllegalArgumentException if either value is <code>null</code> * @throws IllegalArgumentException if either value is <code>null</code>
*/ */
public static <T> Range<T> between(T element1, T element2, Comparator<T> c) { public static <T> Range<T> between(T element1, T element2, Comparator<T> c) {