You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by gg...@apache.org on 2003/12/15 02:17:49 UTC
cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang Tokenizer.java
ggregory 2003/12/14 17:17:49
Modified: lang/src/java/org/apache/commons/lang Tokenizer.java
Log:
Javadoc.
Revision Changes Path
1.2 +31 -6 jakarta-commons/lang/src/java/org/apache/commons/lang/Tokenizer.java
Index: Tokenizer.java
===================================================================
RCS file: /home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/Tokenizer.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Tokenizer.java 17 Nov 2003 23:02:18 -0000 1.1
+++ Tokenizer.java 15 Dec 2003 01:17:49 -0000 1.2
@@ -92,6 +92,7 @@
*
* @author Matthew Inger
* @author Stephen Colebourne
+ * @author Gary D. Gregory
*/
public class Tokenizer implements ListIterator {
// TODO: Constructors
@@ -712,7 +713,7 @@
* This character is ignored when parsing the String, unless it is
* within a quoted region.
*
- * @param quote the ignored character to use
+ * @param ignored the ignored character to use
*/
public void setIgnoredChar(char ignored) {
setIgnoredMatcher(new CharMatcher(ignored));
@@ -733,7 +734,7 @@
* Sets whether the tokenizer should return empty tokens as null.
* The default for this property is false.
*
- * @return emptyAsNull whether empty tokens are returned as null
+ * @param emptyAsNull whether empty tokens are returned as null
*/
public void setEmptyTokenAsNull(boolean emptyAsNull) {
this.emptyAsNull = emptyAsNull;
@@ -754,7 +755,7 @@
* Sets whether the tokenizer should ignore and not return empty tokens.
* The default for this property is false.
*
- * @return ignoreEmptyTokens whether empty tokens are not returned
+ * @param ignoreEmptyTokens whether empty tokens are not returned
*/
public void setIgnoreEmptyTokens(boolean ignoreEmptyTokens) {
this.ignoreEmptyTokens = ignoreEmptyTokens;
@@ -810,8 +811,14 @@
return (char[]) chars.clone();
}
- public boolean isMatch(char c) {
- return (Arrays.binarySearch(chars, c) >= 0);
+ /**
+ * Returns whether or not the given charatcer matches.
+ *
+ * @param ch the character to match.
+ * @return whether or not the given charatcer matches.
+ */
+ public boolean isMatch(char ch) {
+ return (Arrays.binarySearch(chars, ch) >= 0);
}
}
@@ -825,7 +832,7 @@
/**
* Constructor that creates a matcher that matches a single character.
*
- * @param chars the character to match
+ * @param ch the character to match
*/
public CharMatcher(char ch) {
super();
@@ -841,6 +848,12 @@
return this.ch;
}
+ /**
+ * Returns whether or not the given charatcer matches.
+ *
+ * @param ch the character to match.
+ * @return whether or not the given charatcer matches.
+ */
public boolean isMatch(char ch) {
return (this.ch == ch);
}
@@ -856,6 +869,12 @@
super();
}
+ /**
+ * Always returns <code>false</code>.
+ *
+ * @param ch the character to match.
+ * @return Always returns <code>false</code>.
+ */
public boolean isMatch(char ch) {
return false;
}
@@ -871,6 +890,12 @@
super();
}
+ /**
+ * Returns whether or not the given charatcer matches.
+ *
+ * @param ch the character to match.
+ * @return whether or not the given charatcer matches.
+ */
public boolean isMatch(char ch) {
return (ch <= 32);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org