public class StringScanner
extends java.lang.Object
implements java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
class |
StringScanner.BadStringScannerJoin
Exception generated when the StringScanner.join
has two arguments on different base strings
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
base |
protected int |
end |
protected int |
Slength |
protected int |
start |
Constructor and Description |
---|
StringScanner()
No-argument constructor.
|
StringScanner(File f)
Creates a StringScanner over the contents of a file.
|
StringScanner(Reader inrdr)
Creates a StringScanner over the contents of a stream.
|
StringScanner(java.lang.String src)
Creates a StringScanner over a given string.
|
StringScanner(StringScanner src)
Creates a StringScanner over a given substring.
|
Modifier and Type | Method and Description |
---|---|
StringScanner |
allNext() |
StringScanner |
allPrevious() |
boolean |
atEnd() |
StringScanner |
base() |
StringScanner |
blanks()
Isolate the next subsequence of blanks.
|
char |
charAtStart() |
StringScanner |
endMatch(java.lang.String target) |
StringScanner |
endMatchA(java.lang.String target) |
StringScanner |
endMatchAM(java.lang.String target) |
StringScanner |
endMatchAMZ(java.lang.String target) |
StringScanner |
endMatchM(java.lang.String target) |
StringScanner |
endMatchMZ(java.lang.String target) |
StringScanner |
endMatchZ(java.lang.String target) |
StringScanner |
endOneOf(java.lang.String target) |
StringScanner |
endOneOfA(java.lang.String target) |
StringScanner |
endOneOfAM(java.lang.String target) |
StringScanner |
endOneOfAMZ(java.lang.String target) |
StringScanner |
endOneOfM(java.lang.String target) |
StringScanner |
endOneOfMZ(java.lang.String target) |
StringScanner |
endOneOfZ(java.lang.String target) |
StringScanner |
endSpan(java.lang.String target) |
StringScanner |
endSpanA(java.lang.String target) |
StringScanner |
endSpanAM(java.lang.String target) |
StringScanner |
endSpanAMZ(java.lang.String target) |
StringScanner |
endSpanM(java.lang.String target) |
StringScanner |
endSpanMZ(java.lang.String target) |
StringScanner |
endSpanZ(java.lang.String target) |
boolean |
equals(char other)
Compare StringScanner value versus a character
|
boolean |
equals(java.lang.String other)
Compare StringScanner value versus a String
|
boolean |
equals(StringScanner other)
Compare StringScanner value versus a StringScanner value
|
boolean |
equalsIgnoreCase(java.lang.String other)
Compare StringScanner value versus a String, ignoring the case of either.
|
char |
escape()
Process an escape character.
|
StringScanner |
find(char target)
Deprecated.
Adjust bounds and use findM().
|
StringScanner |
find(java.lang.String target)
Deprecated.
Adjust bounds and use findM().
|
StringScanner |
findA(java.lang.String target) |
StringScanner |
findAM(java.lang.String target) |
StringScanner |
findAMZ(java.lang.String target) |
StringScanner |
findInside(java.lang.String target)
Deprecated.
Adjust bounds and use findM().
|
StringScanner |
findLast(java.lang.String target) |
StringScanner |
findLastA(java.lang.String target) |
StringScanner |
findLastAM(java.lang.String target) |
StringScanner |
findLastAMZ(java.lang.String target) |
StringScanner |
findLastM(java.lang.String target) |
StringScanner |
findLastMZ(java.lang.String target) |
StringScanner |
findLastZ(java.lang.String target) |
StringScanner |
findM(java.lang.String target) |
StringScanner |
findMZ(java.lang.String target) |
StringScanner |
findOneOf(java.lang.String target) |
StringScanner |
findOneOfA(java.lang.String target) |
StringScanner |
findOneOfAM(java.lang.String target) |
StringScanner |
findOneOfAMZ(java.lang.String target) |
StringScanner |
findOneOfM(java.lang.String target) |
StringScanner |
findOneOfMZ(java.lang.String target) |
StringScanner |
findOneOfZ(java.lang.String target) |
StringScanner |
findPattern(java.util.regex.Pattern target) |
StringScanner |
findPatternA(java.util.regex.Pattern target) |
StringScanner |
findPatternAM(java.util.regex.Pattern target) |
StringScanner |
findPatternAMZ(java.util.regex.Pattern target) |
StringScanner |
findPatternM(java.util.regex.Pattern target) |
StringScanner |
findPatternMZ(java.util.regex.Pattern target) |
StringScanner |
findPatternZ(java.util.regex.Pattern target) |
StringScanner |
findSpan(java.lang.String target) |
StringScanner |
findSpanA(java.lang.String target) |
StringScanner |
findSpanAM(java.lang.String target) |
StringScanner |
findSpanAMZ(java.lang.String target) |
StringScanner |
findSpanM(java.lang.String target) |
StringScanner |
findSpanMZ(java.lang.String target) |
StringScanner |
findSpanZ(java.lang.String target) |
StringScanner |
findZ(java.lang.String target) |
StringScanner |
finish() |
StringScanner |
first() |
boolean |
found()
Report success of most recent search operation.
|
boolean |
foundAtFinish()
Report success of most recent search operation.
|
boolean |
foundAtStart()
Report whether most recent search abutted start().
|
java.util.regex.Matcher |
getMatcher() |
boolean |
isEmpty() |
boolean |
isNotEmpty() |
StringScanner |
join(StringScanner other)
Select a subsequence extending from the beginning of the selected subsequence
in 'this' to the end of the selected subsequence in the argument.
|
StringScanner |
last() |
java.lang.String |
latestError()
returns the latest error, and clears the error string
|
int |
length() |
boolean |
lessthan(java.lang.String other)
Compare StringScanner value versus a String
|
boolean |
lessthan(StringScanner other)
Analogous to 'lessthan' of a StringScanner vs.
|
StringScanner |
next() |
char |
nextChar() |
StringScanner |
nextId()
Span a Java identifier.
|
StringScanner |
nextN(int n)
Advance forward by a counted number of positions.
|
StringScanner |
nonblankToken()
Like StringTokenizer.
|
StringScanner |
number()
Scan forward from the end of this StringScanner to encompass a number.
|
SSNumber |
numberValue()
Access value from last number() scan
|
int |
position() |
StringScanner |
previous() |
StringScanner |
quotedString()
Isolate a quoted string token.
|
java.lang.String |
quotedStringValue()
Process a selected quoted string to produce the intended value.
|
StringScanner |
selectN(int N)
Select N characters starting at start()
|
boolean |
sequals(StringScanner other)
Test to see if two StringScanner values refer to the same
subsequence of the same base.
|
char |
spanChar()
Adjust this StringScanner to span a sequence of characters for a
valid char string: 'x' or '\...'.
|
long |
spanHex()
Adjust the extent of this scanner so its value spans
hex characters succeeding the original end.
|
long |
spanInteger()
Adjust the extent to span an unsigned integer.
|
long |
spanSignedInteger()
Adjust the extent to span a signed integer.
|
StringScanner |
ssclone()
Creates a new StringScanner identical to this one.
|
StringScanner |
start() |
StringScanner |
startMatch(java.lang.String target) |
StringScanner |
startMatchA(java.lang.String target) |
StringScanner |
startMatchAM(java.lang.String target) |
StringScanner |
startMatchAMZ(java.lang.String target) |
StringScanner |
startMatchM(java.lang.String target) |
StringScanner |
startMatchMZ(java.lang.String target) |
StringScanner |
startMatchZ(java.lang.String target) |
StringScanner |
startOneOf(java.lang.String target) |
StringScanner |
startOneOfA(java.lang.String target) |
StringScanner |
startOneOfAM(java.lang.String target) |
StringScanner |
startOneOfAMZ(java.lang.String target) |
StringScanner |
startOneOfM(java.lang.String target) |
StringScanner |
startOneOfMZ(java.lang.String target) |
StringScanner |
startOneOfZ(java.lang.String target) |
StringScanner |
startSpan(java.lang.String target) |
StringScanner |
startSpanA(java.lang.String target) |
StringScanner |
startSpanAM(java.lang.String target) |
StringScanner |
startSpanAMZ(java.lang.String target) |
StringScanner |
startSpanM(java.lang.String target) |
StringScanner |
startSpanMZ(java.lang.String target) |
StringScanner |
startSpanZ(java.lang.String target) |
java.lang.String |
toString() |
void |
xsSearch(java.lang.String target) |
protected java.lang.String base
protected int start
protected int end
protected int Slength
public StringScanner()
public StringScanner(java.lang.String src)
src
- The String to be the base.public StringScanner(StringScanner src)
src
- The StringScanner whose selected substring
is to be the base for the new StringScannerpublic StringScanner(File f) throws IOException
f
- The File to readIOException
- read errorpublic StringScanner(Reader inrdr) throws IOException
inrdr
- a Reader open on the file to be read in.
The Reader is close()d after it is read in.IOException
- read errorpublic java.lang.String latestError()
public StringScanner ssclone()
public StringScanner start()
public StringScanner finish()
public StringScanner next()
public StringScanner previous()
public StringScanner first()
public StringScanner last()
public StringScanner base()
public StringScanner allNext()
public StringScanner allPrevious()
public int length()
public int position()
public char charAtStart()
public char nextChar()
public boolean isEmpty()
public boolean isNotEmpty()
public boolean atEnd()
public java.lang.String toString()
toString
in class java.lang.Object
public StringScanner join(StringScanner other) throws StringScanner.BadStringScannerJoin
other
- Another StringScanner that selects a subsequence of
the same (==) underlying string.StringScanner.BadStringScannerJoin
- scanners on two different basespublic StringScanner nextN(int n)
n
- Number of positions to advance.public boolean sequals(StringScanner other)
other
- The other StringScanner.public boolean equals(java.lang.String other)
other
- Another stringpublic boolean equalsIgnoreCase(java.lang.String other)
other
- Another stringpublic boolean equals(char other)
other
- A char valuepublic boolean equals(StringScanner other)
other
- Another StringScanner valuepublic boolean lessthan(java.lang.String other)
other
- Another stringpublic boolean lessthan(StringScanner other)
other
- another StringScanner. (If is the same, return value will be false.)public StringScanner blanks()
public StringScanner nonblankToken()
public StringScanner nextId()
public long spanSignedInteger()
public long spanInteger()
public long spanHex()
parseHex(StringScanner)
public StringScanner number()
public SSNumber numberValue()
public char escape()
Defined escapes are
\n newline (0x0a) \b backspace (0x08) \r return (0x0d) \t tab (0x09) \f formfeed (0x0c) \" quote (0x22) \' apostrophe (0x27) \ \\ backslash (0x5c)\ddd (digits) is the character given by the octal value ddd
public StringScanner quotedString()
public java.lang.String quotedStringValue()
public char spanChar()
public StringScanner selectN(int N)
N
- number of characters to selectpublic StringScanner find(java.lang.String target)
target
- String to seek.public StringScanner find(char target)
target
- Character to seek.public StringScanner findInside(java.lang.String target)
target
- String to search for.public boolean found()
public boolean foundAtStart()
public boolean foundAtFinish()
public void xsSearch(java.lang.String target)
public java.util.regex.Matcher getMatcher()
public StringScanner endMatchA(java.lang.String target)
public StringScanner startMatchA(java.lang.String target)
public StringScanner findA(java.lang.String target)
public StringScanner findLastA(java.lang.String target)
public StringScanner startSpanA(java.lang.String target)
public StringScanner findSpanA(java.lang.String target)
public StringScanner findOneOfA(java.lang.String target)
public StringScanner endOneOfA(java.lang.String target)
public StringScanner startOneOfA(java.lang.String target)
public StringScanner endSpanA(java.lang.String target)
public StringScanner findPatternA(java.util.regex.Pattern target)
public StringScanner endMatchAM(java.lang.String target)
public StringScanner startMatchAM(java.lang.String target)
public StringScanner findAM(java.lang.String target)
public StringScanner findLastAM(java.lang.String target)
public StringScanner startSpanAM(java.lang.String target)
public StringScanner findSpanAM(java.lang.String target)
public StringScanner findOneOfAM(java.lang.String target)
public StringScanner endOneOfAM(java.lang.String target)
public StringScanner startOneOfAM(java.lang.String target)
public StringScanner endSpanAM(java.lang.String target)
public StringScanner findPatternAM(java.util.regex.Pattern target)
public StringScanner endMatchM(java.lang.String target)
public StringScanner startMatchM(java.lang.String target)
public StringScanner findM(java.lang.String target)
public StringScanner findLastM(java.lang.String target)
public StringScanner startSpanM(java.lang.String target)
public StringScanner findSpanM(java.lang.String target)
public StringScanner findOneOfM(java.lang.String target)
public StringScanner endOneOfM(java.lang.String target)
public StringScanner startOneOfM(java.lang.String target)
public StringScanner endSpanM(java.lang.String target)
public StringScanner findPatternM(java.util.regex.Pattern target)
public StringScanner endMatch(java.lang.String target)
public StringScanner startMatch(java.lang.String target)
public StringScanner findLast(java.lang.String target)
public StringScanner startSpan(java.lang.String target)
public StringScanner findSpan(java.lang.String target)
public StringScanner findOneOf(java.lang.String target)
public StringScanner endOneOf(java.lang.String target)
public StringScanner startOneOf(java.lang.String target)
public StringScanner endSpan(java.lang.String target)
public StringScanner findPattern(java.util.regex.Pattern target)
public StringScanner endMatchMZ(java.lang.String target)
public StringScanner startMatchMZ(java.lang.String target)
public StringScanner findMZ(java.lang.String target)
public StringScanner findLastMZ(java.lang.String target)
public StringScanner startSpanMZ(java.lang.String target)
public StringScanner findSpanMZ(java.lang.String target)
public StringScanner findOneOfMZ(java.lang.String target)
public StringScanner endOneOfMZ(java.lang.String target)
public StringScanner startOneOfMZ(java.lang.String target)
public StringScanner endSpanMZ(java.lang.String target)
public StringScanner findPatternMZ(java.util.regex.Pattern target)
public StringScanner endMatchZ(java.lang.String target)
public StringScanner startMatchZ(java.lang.String target)
public StringScanner findZ(java.lang.String target)
public StringScanner findLastZ(java.lang.String target)
public StringScanner startSpanZ(java.lang.String target)
public StringScanner findSpanZ(java.lang.String target)
public StringScanner findOneOfZ(java.lang.String target)
public StringScanner endOneOfZ(java.lang.String target)
public StringScanner startOneOfZ(java.lang.String target)
public StringScanner endSpanZ(java.lang.String target)
public StringScanner findPatternZ(java.util.regex.Pattern target)
public StringScanner endMatchAMZ(java.lang.String target)
public StringScanner startMatchAMZ(java.lang.String target)
public StringScanner findAMZ(java.lang.String target)
public StringScanner findLastAMZ(java.lang.String target)
public StringScanner startSpanAMZ(java.lang.String target)
public StringScanner findSpanAMZ(java.lang.String target)
public StringScanner findOneOfAMZ(java.lang.String target)
public StringScanner endOneOfAMZ(java.lang.String target)
public StringScanner startOneOfAMZ(java.lang.String target)
public StringScanner endSpanAMZ(java.lang.String target)
public StringScanner findPatternAMZ(java.util.regex.Pattern target)