Interface JsopReader
-
- All Known Implementing Classes:
JsopStream
,JsopTokenizer
public interface JsopReader
A reader for Json and Jsop strings.
-
-
Field Summary
Fields Modifier and Type Field Description static int
COMMENT
The token type of a comment, if supported by the reader.static int
END
The token type that signals the end of the stream.static int
ERROR
The token type of a parse error.static int
FALSE
The token type of the value "false".static int
IDENTIFIER
The token type of an identifier (an unquoted string), if supported by the reader.static int
NULL
The token type of "null".static int
NUMBER
The token type of a number value.static int
STRING
The token type of a string value.static int
TRUE
The token type of the value "true".
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable String
getToken()
Get the last token value if the the token type was STRING or NUMBER.int
getTokenType()
Get the token type of the last token.boolean
matches(int type)
Read a token which must match a given token type.int
read()
Read a token and return the token type.String
read(int type)
Read a token which must match a given token type.@Nullable String
readRawValue()
Return the row (escaped) token.@Nullable String
readString()
Read a string.void
resetReader()
Reset the position to 0, so that to restart reading.
-
-
-
Field Detail
-
END
static final int END
The token type that signals the end of the stream.- See Also:
- Constant Field Values
-
STRING
static final int STRING
The token type of a string value.- See Also:
- Constant Field Values
-
NUMBER
static final int NUMBER
The token type of a number value.- See Also:
- Constant Field Values
-
TRUE
static final int TRUE
The token type of the value "true".- See Also:
- Constant Field Values
-
FALSE
static final int FALSE
The token type of the value "false".- See Also:
- Constant Field Values
-
NULL
static final int NULL
The token type of "null".- See Also:
- Constant Field Values
-
ERROR
static final int ERROR
The token type of a parse error.- See Also:
- Constant Field Values
-
IDENTIFIER
static final int IDENTIFIER
The token type of an identifier (an unquoted string), if supported by the reader.- See Also:
- Constant Field Values
-
COMMENT
static final int COMMENT
The token type of a comment, if supported by the reader.- See Also:
- Constant Field Values
-
-
Method Detail
-
read
String read(int type)
Read a token which must match a given token type.- Parameters:
type
- the token type- Returns:
- the token (null when reading a null value)
- Throws:
IllegalStateException
- if the token type doesn't match
-
readString
@Nullable @Nullable String readString()
Read a string.- Returns:
- the de-escaped string (null when reading a null value)
- Throws:
IllegalStateException
- if the token type doesn't match
-
read
int read()
Read a token and return the token type.- Returns:
- the token type
-
matches
boolean matches(int type)
Read a token which must match a given token type.- Parameters:
type
- the token type- Returns:
- true if there was a match
-
readRawValue
@Nullable @Nullable String readRawValue()
Return the row (escaped) token.- Returns:
- the escaped string (null when reading a null value)
-
getToken
@Nullable @Nullable String getToken()
Get the last token value if the the token type was STRING or NUMBER. For STRING, the text is decoded; for NUMBER, it is returned as parsed. In all other cases the result is undefined.- Returns:
- the token
-
getTokenType
int getTokenType()
Get the token type of the last token. The token type is one of the known types (END, STRING, NUMBER,...), or, for Jsop tags such as "+", "-", it is the Unicode character code of the tag.- Returns:
- the token type
-
resetReader
void resetReader()
Reset the position to 0, so that to restart reading.
-
-