StringParser (platform/sdk 5.5.1.0-SNAPSHOT API)

java.lang.Object
- com.attivio.sdk.util.StringParser

```
public final class StringParser
extends Object
```
Simple parser for parsing string values into more complex objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StringParser.TokenType
Type for a token.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringParser.TokenType` Type for a token.

Field Summary

Fields
Modifier and Type Field and Description

protected int endOffset

protected int nextStartOffset

protected int startOffset

Fields
Modifier and Type	Field and Description
`protected int`	`endOffset`
`protected int`	`nextStartOffset`
`protected int`	`startOffset`

Constructor Summary

Constructors
Modifier Constructor and Description

protected StringParser(String source, long flags, CgiRequest cgi, MessageMetadata metas)

Constructors
Modifier	Constructor and Description
`protected`	`StringParser(String source, long flags, CgiRequest cgi, MessageMetadata metas)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`eos()` Returns `true` if end of stream has been reached.
`boolean`	`expect(StringParser.TokenType type)`
`boolean`	`expect(StringParser.TokenType a, StringParser.TokenType b)`
`boolean`	`expectBinary()`
`boolean`	`expectDate()`
`BigDecimal`	`expectDecimal()`
`boolean`	`expectKeyword()` Expect an unquoted string.
`boolean`	`expectKeyword(String keyword)`
`boolean`	`expectNumber()`
`boolean`	`expectParameterName()`
`boolean`	`expectQuotedString()` Expect a quoted string.
`boolean`	`expectSingleQuotedString()`
`byte[]`	`getBinary()` Get the current token's text as a `byte[]`.
`Date`	`getDate(TimeZone timeZone)` Get the current token as a Date.
`BigDecimal`	`getDecimal()` Get the current token as a `BigDecimal`.
`double`	`getDouble()` Get the current token as a double.
`int`	`getEndOffset()`
`float`	`getFloat()` Get the current token as a float.
`int`	`getInteger()` Get the current token as an integer.
`long`	`getLong()` Get the current token as a long integer.
`int`	`getNextStartOffset()`
`double`	`getParameter(String key, double defaultValue)` Get the first value for a CGI Parameter as a `double`.
`int`	`getParameter(String key, int defaultValue)` Get the first value for a CGI Parameter as an `int`.
`String`	`getParameter(String key, String defaultValue)` Get the first value for a CGI Parameter.
`int`	`getStartOffset()`
`String`	`getString()` Get the current token's text as a String.
`boolean`	`hasNext()` Returns `true` if there another token is available.
`boolean`	`isNextQuoted()`
`boolean`	`isQuoted()` Was the current token text quoted.
`String`	`nextToken()` The text for the next unconsumed token.
`StringParser.TokenType`	`nextType()`
`static String`	`quote(String text)` Conditionally wrap `text` in double quotes if it contains reserved characters or is an empty string.
`byte[]`	`readBinary()`
`boolean`	`readBoolean()`
`Date`	`readDate(TimeZone timeZone)`
`BigDecimal`	`readDecimal()`
`double`	`readDouble()`
`FieldExpression`	`readFieldExpression()`
`float`	`readFloat()`
`int`	`readInteger()`
`Date`	`readIsoDate(TimeZone timeZone)`
`String`	`readKeyword()`
`long`	`readLong()`
`Point`	`readPoint()`
`String`	`readString()`
`int`	`readUnsigned()`
`StringParser`	`require(StringParser.TokenType type)`
`StringParser`	`require(StringParser.TokenType a, StringParser.TokenType b)`
`StringParser`	`requireEx(StringParser.TokenType type)`
`StringParser`	`requireKeyword(String keyword)`
`static StringParser`	`valueOf(String value)`
`static StringParser`	`valueOf(String value, CgiRequest cgi)`
`static StringParser`	`valueOf(String value, MessageMetadata metas)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

startOffset
```
protected int startOffset
```

endOffset
```
protected int endOffset
```

nextStartOffset
```
protected int nextStartOffset
```

Constructor Detail

StringParser

protected StringParser(String source,
                       long flags,
                       CgiRequest cgi,
                       MessageMetadata metas)

Method Detail

isQuoted
```
public boolean isQuoted()
```
Was the current token text quoted.

nextToken
```
public String nextToken()
```
The text for the next unconsumed token.

nextType

public StringParser.TokenType nextType()

isNextQuoted
```
public boolean isNextQuoted()
```

getParameter

public String getParameter(String key,
                           String defaultValue)

Get the first value for a CGI Parameter.

getParameter

public double getParameter(String key,
                           double defaultValue)

Get the first value for a CGI Parameter as a double.

getParameter

public int getParameter(String key,
                        int defaultValue)

Get the first value for a CGI Parameter as an int.

eos
```
public boolean eos()
```
Returns true if end of stream has been reached.

hasNext
```
public boolean hasNext()
```
Returns true if there another token is available.

expect

public boolean expect(StringParser.TokenType type)

expect

public boolean expect(StringParser.TokenType a,
                      StringParser.TokenType b)

expectParameterName
```
public boolean expectParameterName()
```

expectSingleQuotedString

public boolean expectSingleQuotedString()

expectNumber
```
public boolean expectNumber()
```

expectDate
```
public boolean expectDate()
```

expectBinary
```
public boolean expectBinary()
```

expectQuotedString
```
public boolean expectQuotedString()
```
Expect a quoted string.

expectKeyword
```
public boolean expectKeyword()
```
Expect an unquoted string.

expectKeyword

public boolean expectKeyword(String keyword)

require

public StringParser require(StringParser.TokenType a,
                            StringParser.TokenType b)

require

public StringParser require(StringParser.TokenType type)

requireEx

public StringParser requireEx(StringParser.TokenType type)
                       throws ParseException

Throws:: ParseException

requireKeyword

public StringParser requireKeyword(String keyword)

getStartOffset
```
public int getStartOffset()
```

getEndOffset
```
public int getEndOffset()
```

getNextStartOffset
```
public int getNextStartOffset()
```

getString
```
public String getString()
```
Get the current token's text as a String.

getBinary
```
public byte[] getBinary()
```
Get the current token's text as a byte[].

getFloat
```
public float getFloat()
```
Get the current token as a float.

getDouble
```
public double getDouble()
```
Get the current token as a double.

getInteger
```
public int getInteger()
```
Get the current token as an integer.

getLong
```
public long getLong()
```
Get the current token as a long integer.

getDecimal
```
public BigDecimal getDecimal()
```
Get the current token as a BigDecimal.

getDate

public Date getDate(TimeZone timeZone)

Get the current token as a Date.

readFieldExpression

public FieldExpression readFieldExpression()

readBinary
```
public byte[] readBinary()
```

readString
```
public String readString()
```

readKeyword
```
public String readKeyword()
```

readFloat
```
public float readFloat()
```

readDouble
```
public double readDouble()
```

readPoint
```
public Point readPoint()
```

expectDecimal
```
public BigDecimal expectDecimal()
```

readDecimal
```
public BigDecimal readDecimal()
```

readInteger
```
public int readInteger()
```

readLong
```
public long readLong()
```

readUnsigned
```
public int readUnsigned()
```

readBoolean
```
public boolean readBoolean()
```

readIsoDate

public Date readIsoDate(TimeZone timeZone)

readDate

public Date readDate(TimeZone timeZone)

quote
```
public static String quote(String text)
```
Conditionally wrap text in double quotes if it contains reserved characters or is an empty string.

valueOf

public static StringParser valueOf(String value)

valueOf

public static StringParser valueOf(String value,
                                   MessageMetadata metas)

valueOf

public static StringParser valueOf(String value,
                                   CgiRequest cgi)

Class StringParser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

startOffset

endOffset

nextStartOffset

Constructor Detail

StringParser

Method Detail

isQuoted

nextToken

nextType

isNextQuoted

getParameter

getParameter

getParameter

eos

hasNext

expect

expect

expectParameterName

expectSingleQuotedString

expectNumber

expectDate

expectBinary

expectQuotedString

expectKeyword

expectKeyword

require

require

requireEx

requireKeyword

getStartOffset

getEndOffset

getNextStartOffset

getString

getBinary

getFloat

getDouble

getInteger

getLong

getDecimal

getDate

readFieldExpression

readBinary

readString

readKeyword

readFloat

readDouble

readPoint

expectDecimal

readDecimal

readInteger

readLong

readUnsigned

readBoolean

readIsoDate

readDate

quote

valueOf

valueOf

valueOf