org.pentaho.reporting.libraries.base.util
public class CSVTokenizer extends Object implements Enumeration
StringTokenizer
class. The CSVTokenizer
methods do not distinguish among identifiers, numbers, and quoted strings, nor do they recognize and skip comments.
The set of separator (the characters that separate tokens) may be specified either at creation time or on a per-token
basis.
An instance of CSVTokenizer
behaves in one of two ways, depending on whether it was created with the
returnSeparators
flag having the value true
or false
: false
, delimiter characters serve to separate tokens. A token is a maximal sequence of consecutive
characters that are not separator. true
, delimiter characters are themselves
considered to be tokens. A token is thus either one delimiter character, or a maximal sequence of consecutive
characters that are not separator. A CSVTokenizer object internally maintains a current position within the string to be tokenized. Some operations advance this current position past the characters processed.
A token is returned by taking a substring of the string that was used to create the CSVTokenizer object.
The following is one example of the use of the tokenizer. The code:prints the following output:CSVTokenizer csvt = new CSVTokenizer("this,is,a,test"); while (csvt.hasMoreTokens()) { println(csvt.nextToken()); }
this is a test
Field Summary | |
---|---|
static String | DOUBLE_QUATE
A possible quote character constant. |
static String | SEPARATOR_COMMA
A possible separator constant. |
static String | SEPARATOR_SPACE
A possible separator constant. |
static String | SEPARATOR_TAB
A possible separator constant. |
static String | SINGLE_QUATE
A possible quote character constant. |
Constructor Summary | |
---|---|
CSVTokenizer(String aString, String theSeparator, String theQuate)
Constructs a csv tokenizer for the specified string. | |
CSVTokenizer(String aString, String theSeparator)
Constructs a csv tokenizer for the specified string. | |
CSVTokenizer(String aString)
Constructs a string tokenizer for the specified string. |
Method Summary | |
---|---|
int | countTokens()
Calculates the number of times that this tokenizer's nextToken method can be called before it
generates an exception. |
String | getQuate()
Returns the quate.
|
boolean | hasMoreElements()
Returns the same value as the hasMoreTokens method. |
boolean | hasMoreTokens()
Tests if there are more tokens available from this tokenizer's string. |
Object | nextElement()
Returns the same value as the nextToken method, except that its declared return value is
Object rather than String . |
String | nextToken()
Returns the next token from this string tokenizer.
|
String | nextToken(String theSeparator)
Returns the next token in this string tokenizer's string. |
void | setQuate(String quate)
Sets the quate.
|
theSeparator
argument is the separator for
separating tokens.
If the returnSeparators
flag is true
, then the separator string is also returned as
tokens. separator is returned as a string. If the flag is false
, the separator string is skipped and
only serve as separator between tokens.
Parameters: aString a string to be parsed. theSeparator the separator (CSVTokenizer.SEPARATOR_COMMA, CSVTokenizer.TAB, CSVTokenizer.SPACE, etc.). theQuate the quate (CSVTokenizer.SINGLE_QUATE, CSVTokenizer.DOUBLE_QUATE, etc.).
theSeparator
argument are
the separator for separating tokens. Separator string themselves will not be treated as tokens.
Parameters: aString a string to be parsed. theSeparator the separator (CSVTokenizer.SEPARATOR_COMMA, CSVTokenizer.TAB, CSVTokenizer.SPACE, etc.).
CSVTokenizer.SEPARATOR_COMMA
. Separator string themselves will not be treated as tokens.
Parameters: aString a string to be parsed.
nextToken
method can be called before it
generates an exception. The current position is not advanced.
Returns: the number of tokens remaining in the string using the current delimiter set.
See Also: nextToken
Returns: char
hasMoreTokens
method. It exists so that this class can implement the
Enumeration
interface.
Returns: true
if there are more tokens; false
otherwise.
See Also: Enumeration hasMoreTokens
Returns: true
if and only if there is at least one token in the string after the current position;
false
otherwise.
nextToken
method, except that its declared return value is
Object
rather than String
. It exists so that this class can implement the
Enumeration
interface.
Returns: the next token in the string.
Throws: NoSuchElementException if there are no more tokens in this tokenizer's string.
See Also: Enumeration nextToken
Returns: the next token from this string tokenizer.
Throws: NoSuchElementException if there are no more tokens in this tokenizer's string. IllegalArgumentException if given parameter string format was wrong
Parameters: theSeparator the new separator.
Returns: the next token, after switching to the new delimiter set.
Throws: NoSuchElementException if there are no more tokens in this tokenizer's string.
Parameters: quate The quate to set