JsonElementStream (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.json.JsonElementStream

public class JsonElementStream
extends java.lang.Object

A stream of JSON JsonElement.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonArray`	`beginArray()` Return (nullable) A new JSON array, after consuming the '[' token.
`JsonObject`	`beginObject()` Return (nullable) A new JSON object, after consuming the '{' token.
`JsonElementStream`	`decompress()` Enable decompression, where the document may contain an outermost object whose first field has name "$" and whose value is a compression dictionary expressed as an array of strings.
`void`	`endArray()` Expect the next token to be a ']' (end of array), and consume the token.
`void`	`endObject()` Expect the next token to be a '}' (end of object), and consume the token.
`JsonBooleanToken`	`expectBoolean()` Return the next token.
`void`	`expectColon()` Expect the next token to be a colon, and consume the token.
`void`	`expectComma()` Expect the next token to be a comma, and consume the token.
`JsonNumberToken`	`expectNumber()` Return the next token.
`JsonStringToken`	`expectString()` Return the next token.
`static JsonElementStream`	`fromStream(CharStream stream)` See fromStream(CharStream, boolean).
`static JsonElementStream`	`fromStream(CharStream stream, boolean optimized)` Return a new content stream taking input from `stream`.
`static JsonElementStream`	`fromString(java.lang.String text)` See fromString(String, boolean).
`static JsonElementStream`	`fromString(java.lang.String text, boolean optimized)` Return a new content stream taking input from `text`.
`static JsonElementStream`	`fromTokens(JsonTokenStream tokens)` See fromTokens(JsonTokenStream, boolean).
`static JsonElementStream`	`fromTokens(JsonTokenStream tokens, boolean optimized)` Return a new content stream taking input from `tokens`.
`boolean`	`isEndArray()` Return `true` if the next token indicates the the end of an array (']').
`boolean`	`isEndObject()` Return `true` if the next token indicates the the end of an object ('}').
`boolean`	`lookingAt(int type)` Return `true` if the next token has the specfied type.
`JsonArray`	`readArray()` Return the next JSON array read from the stream.
`JsonElement`	`readElement()` Return (nullable) The next JSON value (null, boolean, number, string, array, object) read from the stream.
`JsonObject`	`readObject()` Return the next JSON object read from the stream.
`java.lang.String`	`readString()` Return the next JSON string read from the stream.

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

- Method Detail
  - beginArray
```
public JsonArray beginArray()
```
    Return (nullable) A new JSON array, after consuming the '[' token. Or return null if the next token is not the start of an array.
    
    Returns:
    
    (nullable) A new JSON array, after consuming the '[' token. Or return null if the next token is not the start of an array.
  - beginObject
```
public JsonObject beginObject()
```
    Return (nullable) A new JSON object, after consuming the '{' token. Or return null if the next token is not the start of an object.
    
    Returns:
    
    (nullable) A new JSON object, after consuming the '{' token. Or return null if the next token is not the start of an object.
  - decompress
```
public JsonElementStream decompress()
```
    Enable decompression, where the document may contain an outermost object whose first field has name "$" and whose value is a compression dictionary expressed as an array of strings. Elsewhere in the document, a field name "$N" (where N is an integer >= 0) will be treated as a shorthand for the correponding name in the compression dictionary. Example:
```
{"$": "ABC", "XYZ", "value": {"$0": 123}, {"$1": 789}}
 is decompressed as {"value": {"ABC": 123}, {"XYZ": 789}}
 
```
    Returns:
    
    This element stream, with decompression enabled.
  - endArray
```
public void endArray()
```
    Expect the next token to be a ']' (end of array), and consume the token.
  - endObject
```
public void endObject()
```
    Expect the next token to be a '}' (end of object), and consume the token.
  - expectBoolean
```
public JsonBooleanToken expectBoolean()
```
    Return the next token. Expect the next token to be a boolean value, and consume the token.
    
    Returns:
    
    The next token.
  - expectColon
```
public void expectColon()
```
    Expect the next token to be a colon, and consume the token.
  - expectComma
```
public void expectComma()
```
    Expect the next token to be a comma, and consume the token.
  - expectNumber
```
public JsonNumberToken expectNumber()
```
    Return the next token. Expect the next token to be a number value, and consume the token.
    
    Returns:
    
    The next token.
  - expectString
```
public JsonStringToken expectString()
```
    Return the next token. Expect the next token to be a string value, and consume the token.
    
    Returns:
    
    The next token.
  - fromStream
```
public static JsonElementStream fromStream(CharStream stream)
```
    See fromStream(CharStream, boolean).
    
    Parameters:
    
    stream - Stream parameter.
    
    Returns:
    
    (see linked method).
  - fromStream
```
public static JsonElementStream fromStream(CharStream stream,
                                           boolean optimized)
```
    Return a new content stream taking input from stream.
    
    Parameters:
    
    stream - Input stream.
    
    optimized - See JsonElement.parseOptimized.
    
    Returns:
    
    A new content stream taking input from stream.
  - fromString
```
public static JsonElementStream fromString(java.lang.String text)
```
    See fromString(String, boolean).
    
    Parameters:
    
    text - Text parameter.
    
    Returns:
    
    (see linked method).
  - fromString
```
public static JsonElementStream fromString(java.lang.String text,
                                           boolean optimized)
```
    Return a new content stream taking input from text.
    
    Parameters:
    
    text - Input text.
    
    optimized - See JsonElement.parseOptimized.
    
    Returns:
    
    A new content stream taking input from text.
  - fromTokens
```
public static JsonElementStream fromTokens(JsonTokenStream tokens)
```
    See fromTokens(JsonTokenStream, boolean).
    
    Parameters:
    
    tokens - Tokens parameter.
    
    Returns:
    
    (see linked method).
  - fromTokens
```
public static JsonElementStream fromTokens(JsonTokenStream tokens,
                                           boolean optimized)
```
    Return a new content stream taking input from tokens.
    
    Parameters:
    
    tokens - Input tokens.
    
    optimized - See JsonElement.parseOptimized.
    
    Returns:
    
    A new content stream taking input from tokens.
  - isEndArray
```
public boolean isEndArray()
```
    Return true if the next token indicates the the end of an array (']').
    
    Returns:
    
    true if the next token indicates the the end of an array (']').
  - isEndObject
```
public boolean isEndObject()
```
    Return true if the next token indicates the the end of an object ('}').
    
    Returns:
    
    true if the next token indicates the the end of an object ('}').
  - lookingAt
```
public boolean lookingAt(int type)
```
    Return true if the next token has the specfied type.
    
    See Also:
    
    JsonToken.type.
    
    Parameters:
    
    type - Token type.
    
    Returns:
    
    `true` if the next token has the specfied type.
  - readArray
```
public JsonArray readArray()
```
    Return the next JSON array read from the stream.
    
    Returns:
    
    The next JSON array read from the stream.
  - readElement
```
public JsonElement readElement()
```
    Return (nullable) The next JSON value (null, boolean, number, string, array, object) read from the stream.
    
    Returns:
    
    (nullable) The next JSON value (null, boolean, number, string, array, object) read from the stream.
  - readObject
```
public JsonObject readObject()
```
    Return the next JSON object read from the stream.
    
    Returns:
    
    The next JSON object read from the stream.
  - readString
```
public java.lang.String readString()
```
    Return the next JSON string read from the stream.
    
    Returns:
    
    The next JSON string read from the stream.

Class JsonElementStream

Method Summary

Methods inherited from class java.lang.Object

Method Detail

beginArray

beginObject

decompress

endArray

endObject

expectBoolean

expectColon

expectComma

expectNumber

expectString

fromStream

fromStream

fromString

fromString

fromTokens

fromTokens

isEndArray

isEndObject

lookingAt

readArray

readElement

readObject

readString