null
* @param valueToFind the value to find
* @param startIndex the start index to travers backwards from
+ * @param tolerance search for value within plus/minus this amount
* @return the last index of the value within the array,
* -1 if not found or null array input
*/
@@ -1574,9 +1576,10 @@ public static boolean contains(final double[] array, final double valueToFind) {
* The method returns false if a null array
* is passed in.
A set of characters.
- * + * *This class is immutable, but subclasses may not be.
* * @author Henri Yandell * @author Stephen Colebourne * @author Phil Steitz + * @author Pete Gieser * @since 1.0 - * @version $Id: CharSet.java,v 1.14 2003/08/07 21:12:19 bayard Exp $ + * @version $Id: CharSet.java,v 1.15 2003/08/16 11:04:46 scolebourne Exp $ */ public class CharSet implements Serializable { /** Serialization lock, Lang version 2.0. */ private static final long serialVersionUID = 5947847346149275958L; - + /** A CharSet defining no characters. */ public static final CharSet EMPTY = new CharSet((String) null); /** A CharSet defining ASCII alphabetic characters "a-zA-Z". */ @@ -86,7 +87,7 @@ public class CharSet implements Serializable { public static final CharSet ASCII_ALPHA_UPPER = new CharSet("A-Z"); /** A CharSet defining ASCII alphabetic characters "0-9". */ public static final CharSet ASCII_NUMERIC = new CharSet("0-9"); - + /** * A Map of the common cases used in the factory. * Subclasses can add more common patterns if desired. @@ -101,14 +102,14 @@ public class CharSet implements Serializable { COMMON.put("A-Z", ASCII_ALPHA_UPPER); COMMON.put("0-9", ASCII_NUMERIC); } - + /** The set of CharRange objects. */ private Set set = new HashSet(); //----------------------------------------------------------------------- /** *Factory method to create a new CharSet using a special syntax.
- * + * *null or empty string ("")
* - set containing no charactersThe matching order is:
*Matching works left to right. Once a match is found the * search starts again from the next character.
- * + * *If the same range is defined twice using the same syntax, only * one range will be kept. * Thus, "a-ca-c" creates only one range of "a-c".
@@ -144,8 +145,9 @@ public class CharSet implements Serializable { *The set of characters represented is the union of the specified ranges.
* *All CharSet objects returned by this method will be immutable.
- * + * * @param setStr the String describing the set, may be null + * @return a CharSet instance */ public static CharSet getInstance(String setStr) { Object set = COMMON.get(setStr); @@ -170,6 +172,7 @@ protected CharSet(String setStr) { *Constructs a new CharSet using the set syntax. * Each string is merged in with the set.
* + * @param set Strings to merge into the initial set * @throws NullPointerException if set isnull
*/
protected CharSet(String[] set) {
@@ -183,7 +186,7 @@ protected CharSet(String[] set) {
//-----------------------------------------------------------------------
/**
* Add a set definition string to the CharSet.
Gets the internal set as an array of CharRange objects.
- * + * * @return an array of immutable CharRange objects */ public CharRange[] getCharRanges() { return (CharRange[]) set.toArray(new CharRange[set.size()]); } - + //----------------------------------------------------------------------- /** *Does the CharSet contain the specified
* character ch.
true if the set contains the characters
*/
@@ -248,11 +251,10 @@ public boolean contains(char ch) {
/**
* Compares two CharSet objects, returning true if they represent * exactly the same set of characters defined in the same way.
- * + * *The two sets abc and a-c are not
* equal according to this method.
Gets a hashCode compatable with the equals method.
- * + * * @return a suitable hashCode */ public int hashCode() { return 89 + set.hashCode(); } - + /** *Gets a string representation of the set.
- * + * * @return string representation of the set */ public String toString() { diff --git a/src/java/org/apache/commons/lang/StringEscapeUtils.java b/src/java/org/apache/commons/lang/StringEscapeUtils.java index f345abc9d..49b44894e 100644 --- a/src/java/org/apache/commons/lang/StringEscapeUtils.java +++ b/src/java/org/apache/commons/lang/StringEscapeUtils.java @@ -72,8 +72,9 @@ * @author Sean Brown * @author Gary Gregory * @author Phil Steitz + * @author Pete Gieser * @since 2.0 - * @version $Id: StringEscapeUtils.java,v 1.23 2003/08/01 20:45:17 scolebourne Exp $ + * @version $Id: StringEscapeUtils.java,v 1.24 2003/08/16 11:04:46 scolebourne Exp $ */ public class StringEscapeUtils { @@ -308,6 +309,7 @@ public static String unescapeJava(String str) { * @param out theWriter used to output unescaped characters
* @param str the String to unescape, may be null
* @throws IllegalArgumentException if the Writer is null
+ * @throws IOException if error occurs on undelying Writer
*/
public static void unescapeJava(Writer out, String str) throws IOException {
if (out == null) {
@@ -422,6 +424,7 @@ public static String unescapeJavaScript(String str) {
* @param out the Writer used to output unescaped characters
* @param str the String to unescape, may be null
* @throws IllegalArgumentException if the Writer is null
+ * @throws IOException if error occurs on undelying Writer
*/
public static void unescapeJavaScript(Writer out, String str) throws IOException {
unescapeJava(out, str);
diff --git a/src/java/org/apache/commons/lang/enum/package.html b/src/java/org/apache/commons/lang/enum/package.html
index 214f8d542..3a174f269 100644
--- a/src/java/org/apache/commons/lang/enum/package.html
+++ b/src/java/org/apache/commons/lang/enum/package.html
@@ -30,5 +30,6 @@
}
}
+@since 1.0