org.ojai

Interface DocumentBuilder

@API.Public
 @API.NotThreadSafe
public interface DocumentBuilder

Method Summary

Modifier and Type	Method and Description
DocumentBuilder	add(BigDecimal value) Adds a BigDecimal value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(boolean value) Adds a boolean value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(byte value) Adds a byte value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(byte[] value) Appends the byte array as a BINARY value to the current array.
DocumentBuilder	add(byte[] value, int offset, int length) Appends the byte array bounded by offset and length as a BINARY value to the current array.
DocumentBuilder	add(ByteBuffer value) Appends the ByteBuffer as a BINARY value to the current array.
DocumentBuilder	add(Document value) Appends the Document to the current array.
DocumentBuilder	add(double value) Adds a double value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(float value) Adds a float value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(int value) Adds an int value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(long value) Adds a long value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(ODate value)
DocumentBuilder	add(OInterval value)
DocumentBuilder	add(OTime value)
DocumentBuilder	add(OTimestamp value)
DocumentBuilder	add(short value) Adds a short value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(String value) Adds a String value at the current index in the current array and advances the current index by 1.
DocumentBuilder	add(Value value) Appends the Value to the current array.
DocumentBuilder	addDate(int days) Appends the specified date value represented as the number of days since epoch to the current array.
DocumentBuilder	addDecimal(byte[] unscaledValue, int scale) Adds a byte array containing the two's complement binary representation and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
DocumentBuilder	addDecimal(double decimalValue) Adds a double number as a DECIMAL value at the current index in the current array and advances the current index by 1.
DocumentBuilder	addDecimal(int unscaledValue, int scale) Adds an int unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
DocumentBuilder	addDecimal(long decimalValue) Adds a long number as a DECIMAL value at the current index in the current array and advances the current index by 1.
DocumentBuilder	addDecimal(long unscaledValue, int scale) Adds an long unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1.
DocumentBuilder	addInterval(long durationInMs)
DocumentBuilder	addNewArray()
DocumentBuilder	addNewMap()
DocumentBuilder	addNull() Appends a NULL value to the current array.
DocumentBuilder	addTime(int millis) Appends the specified time value represented as number of milliseconds since midnight to the current array.
DocumentBuilder	addTimestamp(long timeMillis)
DocumentBuilder	endArray()
DocumentBuilder	endMap()
Document	getDocument()
DocumentBuilder	put(String field, BigDecimal value)
DocumentBuilder	put(String field, boolean value) Associates the specified boolean value with the specified field in the current map.
DocumentBuilder	put(String field, byte value)
DocumentBuilder	put(String field, byte[] value)
DocumentBuilder	put(String field, byte[] value, int offset, int length)
DocumentBuilder	put(String field, ByteBuffer value)
DocumentBuilder	put(String field, Document value)
DocumentBuilder	put(String field, double value)
DocumentBuilder	put(String field, float value)
DocumentBuilder	put(String field, int value)
DocumentBuilder	put(String field, long value)
DocumentBuilder	put(String field, Map<String,Object> value)
DocumentBuilder	put(String field, ODate value)
DocumentBuilder	put(String field, OInterval value)
DocumentBuilder	put(String field, OTime value)
DocumentBuilder	put(String field, OTimestamp value)
DocumentBuilder	put(String field, short value)
DocumentBuilder	put(String field, String value) Associates the specified String value with the specified field in the current map.
DocumentBuilder	put(String field, Value value)
DocumentBuilder	putDate(String field, int days) Associates the specified date value represented as the number of days since epoch with the specified field in the current map.
DocumentBuilder	putDecimal(String field, byte[] unscaledValue, int scale)
DocumentBuilder	putDecimal(String field, double decimalValue)
DocumentBuilder	putDecimal(String field, int unscaledValue, int scale)
DocumentBuilder	putDecimal(String field, long decimalValue)
DocumentBuilder	putDecimal(String field, long unscaledValue, int scale)
DocumentBuilder	putInterval(String field, int months, int days, int milliseconds)
DocumentBuilder	putInterval(String field, long durationInMs)
DocumentBuilder	putNewArray(String field)
DocumentBuilder	putNewMap(String field)
DocumentBuilder	putNull(String field)
DocumentBuilder	putTime(String field, int millis) Associates the specified time value represented as number of milliseconds since midnight with the specified field in the current map.
DocumentBuilder	putTimestamp(String field, long timeMillis) Associates the specified timestamp value represented as the number of milliseconds since epoch with the specified field in the current map.
DocumentBuilder	setArrayIndex(int index) Sets the index in the current array at which the next value will be added.

Method Detail

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    boolean value)

Associates the specified boolean value with the specified field in the current map. Any previous association will be overwritten.

Parameters:

field - the name of the field

value - the boolean value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a MAP segment

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    String value)

Associates the specified String value with the specified field in the current map. Any previous association will be overwritten.

Parameters:

field - the name of the field

value - the String value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a MAP segment

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    byte value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    short value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    int value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    long value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    float value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    double value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    BigDecimal value)

putDecimal

DocumentBuilder putDecimal(@API.NonNullable
                           String field,
                           long decimalValue)

putDecimal

DocumentBuilder putDecimal(@API.NonNullable
                           String field,
                           double decimalValue)

putDecimal

DocumentBuilder putDecimal(@API.NonNullable
                           String field,
                           int unscaledValue,
                           int scale)

putDecimal

DocumentBuilder putDecimal(@API.NonNullable
                           String field,
                           long unscaledValue,
                           int scale)

putDecimal

DocumentBuilder putDecimal(@API.NonNullable
                           String field,
                           @API.NonNullable
                           byte[] unscaledValue,
                           int scale)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    byte[] value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    byte[] value,
                    int offset,
                    int length)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    ByteBuffer value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    ODate value)

putDate

DocumentBuilder putDate(@API.NonNullable
                        String field,
                        int days)

Associates the specified date value represented as the number of days since epoch with the specified field in the current map. Any previous association will be overwritten.

Parameters:

field - the name of the field

days - the date value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a MAP segment

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    OTime value)

putTime

DocumentBuilder putTime(@API.NonNullable
                        String field,
                        int millis)

Associates the specified time value represented as number of milliseconds since midnight with the specified field in the current map. Any previous association will be overwritten.

Parameters:

field - the name of the field

millis - the time value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a MAP segment

IllegalArgumentException - if the value of millis is greater than 86400000

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    OTimestamp value)

putTimestamp

DocumentBuilder putTimestamp(@API.NonNullable
                             String field,
                             long timeMillis)

Associates the specified timestamp value represented as the number of milliseconds since epoch with the specified field in the current map. Any previous association will be overwritten.

Parameters:

field - the name of the field

timeMillis - the timestamp value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a MAP segment

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    OInterval value)

putInterval

DocumentBuilder putInterval(@API.NonNullable
                            String field,
                            long durationInMs)

putInterval

DocumentBuilder putInterval(@API.NonNullable
                            String field,
                            int months,
                            int days,
                            int milliseconds)

putNewMap

DocumentBuilder putNewMap(@API.NonNullable
                          String field)

putNewArray

DocumentBuilder putNewArray(@API.NonNullable
                            String field)

putNull

DocumentBuilder putNull(@API.NonNullable
                        String field)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    Value value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    Document value)

put

DocumentBuilder put(@API.NonNullable
                    String field,
                    @API.NonNullable
                    Map<String,Object> value)

setArrayIndex

DocumentBuilder setArrayIndex(int index)

Sets the index in the current array at which the next value will be added.

Parameters:

index - the index at which the next value will be added

Returns:

this for chained invocation

Throws:

IllegalArgumentException - if the index is not larger than the last written index.

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(boolean value)

Adds a boolean value at the current index in the current array and advances the current index by 1.

Parameters:

value - the boolean value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    String value)

Adds a String value at the current index in the current array and advances the current index by 1.

Parameters:

value - the String value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(byte value)

Adds a byte value at the current index in the current array and advances the current index by 1.

Parameters:

value - the byte value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(short value)

Adds a short value at the current index in the current array and advances the current index by 1.

Parameters:

value - the short value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(int value)

Adds an int value at the current index in the current array and advances the current index by 1.

Parameters:

value - the int value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment.

add

DocumentBuilder add(long value)

Adds a long value at the current index in the current array and advances the current index by 1.

Parameters:

value - the long value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(float value)

Adds a float value at the current index in the current array and advances the current index by 1.

Parameters:

value - the float value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(double value)

Adds a double value at the current index in the current array and advances the current index by 1.

Parameters:

value - the double value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    BigDecimal value)

Adds a BigDecimal value at the current index in the current array and advances the current index by 1.

Parameters:

value - the BigDecimal value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addDecimal

DocumentBuilder addDecimal(long decimalValue)

Adds a long number as a DECIMAL value at the current index in the current array and advances the current index by 1.

Parameters:

decimalValue - the long value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addDecimal

DocumentBuilder addDecimal(double decimalValue)

Adds a double number as a DECIMAL value at the current index in the current array and advances the current index by 1.

Parameters:

decimalValue - the double value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addDecimal

DocumentBuilder addDecimal(int unscaledValue,
                           int scale)

Adds an int unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1. The DECIMAL value is (unscaledValue × 10^-scale).

Parameters:

unscaledValue - unscaled value of the DECIMAL

scale - scale of the DECIMAL

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addDecimal

DocumentBuilder addDecimal(long unscaledValue,
                           int scale)

Adds an long unscaled value and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1. The DECIMAL value is (unscaledValue × 10^-scale).

Parameters:

unscaledValue - unscaled value of the DECIMAL

scale - scale of the DECIMAL

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addDecimal

DocumentBuilder addDecimal(@API.NonNullable
                           byte[] unscaledValue,
                           int scale)

Adds a byte array containing the two's complement binary representation and an int scale as a DECIMAL value at the current index in the current array and advances the current index by 1. The input array is assumed to be in big-endian byte-order: the most significant byte is in the zeroth element.

Parameters:

unscaledValue - unscaled value of the DECIMAL

scale - scale of the DECIMAL

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    byte[] value)

Appends the byte array as a BINARY value to the current array.

Parameters:

value - the byte array to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    byte[] value,
                    int offset,
                    int length)

Appends the byte array bounded by offset and length as a BINARY value to the current array.

Parameters:

value - the byte array to append

offset - the start offset in the byte array

length - the length from the offset

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

IndexOutOfBoundsException - if the offset or offset+length are outside of byte array range

add

DocumentBuilder add(@API.NonNullable
                    ByteBuffer value)

Appends the ByteBuffer as a BINARY value to the current array.

Parameters:

value - the ByteBuffer to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addNull

DocumentBuilder addNull()

Appends a NULL value to the current array.

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    Value value)

Appends the Value to the current array.

Parameters:

value - the Value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    Document value)

Appends the Document to the current array.

Parameters:

value - the Document to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in an ARRAY segment

addNewArray

DocumentBuilder addNewArray()

addNewMap

DocumentBuilder addNewMap()

add

DocumentBuilder add(@API.NonNullable
                    OTime value)

addTime

DocumentBuilder addTime(int millis)

Appends the specified time value represented as number of milliseconds since midnight to the current array.

Parameters:

millis - the time value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a ARRAY segment

IllegalArgumentException - if the value of millis is greater than 86400000

add

DocumentBuilder add(@API.NonNullable
                    ODate value)

addDate

DocumentBuilder addDate(int days)

Appends the specified date value represented as the number of days since epoch to the current array.

Parameters:

days - the date value to append

Returns:

this for chained invocation

Throws:

IllegalStateException - if the builder is not in a ARRAY segment

add

DocumentBuilder add(@API.NonNullable
                    OTimestamp value)

addTimestamp

DocumentBuilder addTimestamp(long timeMillis)

add

DocumentBuilder add(@API.NonNullable
                    OInterval value)

addInterval

DocumentBuilder addInterval(long durationInMs)

endArray

DocumentBuilder endArray()

endMap

DocumentBuilder endMap()

getDocument

Document getDocument()