Interface ListBuilder

@Experimental
public interface ListBuilder

Appends the entries of one LIST instance.

The verb matches the list's element type: a list of primitives takes addString(String) and its siblings, a list of structs takes addStruct(Consumer), and a list of lists or of maps takes addList(Consumer) / addMap(Consumer). Using a verb the element type does not fit throws at the call.

row.setList("phones", phones -> phones
        .addString("+49 30 1234567")
        .addString("+1 415 5550100"));

Every entry the filler appends is one element of the list, in the order appended. A filler that appends nothing writes an empty list, which is distinct from the absent list that leaving the field unset writes.

The builder is valid only inside the lambda it was passed to. Retaining one and using it afterwards throws IllegalStateException rather than appending to a later list.

This API is Experimental: the shape may change in future releases.

Method Summary

Modifier and Type	Method	Description
ListBuilder	addBinary(byte[] value)	Appends a BYTE_ARRAY or FIXED_LEN_BYTE_ARRAY entry.
ListBuilder	addBoolean(boolean value)	Appends a BOOLEAN entry.
ListBuilder	addDate(LocalDate value)	Appends a DATE entry.
ListBuilder	addDecimal(BigDecimal value)	Appends a DECIMAL entry.
ListBuilder	addDouble(double value)	Appends a DOUBLE entry.
ListBuilder	addFloat(float value)	Appends a FLOAT entry.
ListBuilder	addInt(int value)	Appends an INT32 entry.
ListBuilder	addInterval(PqInterval value)	Appends an INTERVAL entry.
ListBuilder	addList(Consumer<ListBuilder> filler)	Appends a nested list entry, populating it through filler.
ListBuilder	addLocalTimestamp(LocalDateTime value)	Appends a local-wall-clock TIMESTAMP entry.
ListBuilder	addLong(long value)	Appends an INT64 entry.
ListBuilder	addMap(Consumer<MapBuilder> filler)	Appends a map entry, populating it through filler.
ListBuilder	addNull()	Appends a null entry, which occupies a position in the list — distinct from the list itself being absent, and from the list being empty.
ListBuilder	addString(String value)	Appends a STRING, ENUM or JSON entry from its UTF-8 bytes.
ListBuilder	addStruct(Consumer<StructBuilder> filler)	Appends a struct entry, populating it through filler.
ListBuilder	addTime(LocalTime value)	Appends a TIME entry.
ListBuilder	addTimestamp(Instant value)	Appends a UTC-adjusted TIMESTAMP entry.
ListBuilder	addUuid(UUID value)	Appends a UUID entry.

Method Details

addInt

ListBuilder addInt(int value)

Appends an INT32 entry.

Parameters:

value - the value

Returns:

this builder, for chaining

Throws:

IllegalArgumentException - if the element is not an INT32 leaf, or the value is out of range for the element's annotation

IllegalStateException - if this builder's scope has ended

See Also:

• StructBuilder.setInt(String, int)

addLong

ListBuilder addLong(long value)

Appends an INT64 entry.

See Also:

• addInt(int)

addFloat

ListBuilder addFloat(float value)

Appends a FLOAT entry.

See Also:

• addInt(int)

addDouble

ListBuilder addDouble(double value)

Appends a DOUBLE entry.

See Also:

• addInt(int)

addBoolean

ListBuilder addBoolean(boolean value)

Appends a BOOLEAN entry.

See Also:

• addInt(int)

addString

ListBuilder addString(String value)

Appends a STRING, ENUM or JSON entry from its UTF-8 bytes. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setString(String, String)

addBinary

ListBuilder addBinary(byte[] value)

Appends a BYTE_ARRAY or FIXED_LEN_BYTE_ARRAY entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setBinary(String, byte[])

addDate

ListBuilder addDate(LocalDate value)

Appends a DATE entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setDate(String, LocalDate)

addTime

ListBuilder addTime(LocalTime value)

Appends a TIME entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setTime(String, LocalTime)

addTimestamp

ListBuilder addTimestamp(Instant value)

Appends a UTC-adjusted TIMESTAMP entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setTimestamp(String, Instant)

addLocalTimestamp

ListBuilder addLocalTimestamp(LocalDateTime value)

Appends a local-wall-clock TIMESTAMP entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setLocalTimestamp(String, LocalDateTime)

addDecimal

ListBuilder addDecimal(BigDecimal value)

Appends a DECIMAL entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setDecimal(String, BigDecimal)

addUuid

ListBuilder addUuid(UUID value)

Appends a UUID entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setUuid(String, UUID)

addInterval

ListBuilder addInterval(PqInterval value)

Appends an INTERVAL entry. A null value appends a null entry.

See Also:

• addInt(int)
• StructBuilder.setInterval(String, PqInterval)

addNull

ListBuilder addNull()

Appends a null entry, which occupies a position in the list — distinct from the list itself being absent, and from the list being empty.

Returns:

this builder, for chaining

Throws:

IllegalArgumentException - if the list's element is REQUIRED

IllegalStateException - if this builder's scope has ended

addStruct

ListBuilder addStruct(Consumer<StructBuilder> filler)

Appends a struct entry, populating it through filler.

Parameters:

filler - populates the entry

Returns:

this builder, for chaining

Throws:

IllegalArgumentException - if the list's element is not a struct group

IllegalStateException - if this builder's scope has ended

addList

ListBuilder addList(Consumer<ListBuilder> filler)

Appends a nested list entry, populating it through filler.

Parameters:

filler - appends the nested list's entries

Returns:

this builder, for chaining

Throws:

IllegalArgumentException - if the list's element is not a LIST group

IllegalStateException - if this builder's scope has ended

addMap

ListBuilder addMap(Consumer<MapBuilder> filler)

Appends a map entry, populating it through filler.

Parameters:

filler - appends the map's entries

Returns:

this builder, for chaining

Throws:

IllegalArgumentException - if the list's element is not a MAP group

IllegalStateException - if this builder's scope has ended