com.speedment.config

Interface Document

All Known Subinterfaces:

Column, Dbms, ForeignKey, ForeignKeyColumn, HasAlias, HasChildren, HasColumn, HasEnabled, HasMainInterface, HasName, HasNullable, HasOrderType, HasOrdinalPosition, HasParent<PARENT>, Index, IndexColumn, PrimaryKeyColumn, Project, Schema, Table

public interface Document

The Document is the base structure for storing configuration parameters and can be seen as a hierarchial key-value store. Parameters can be retreived using the different typed getAsXXX() methods listed here:

• get(String)
• getAsBoolean(String)
• getAsLong(String)
• getAsDouble(String)
• getAsInt(String)
• getAsString(String)

To traverse the document tree, the children(String, BiFunction) method can be used. It takes a key and a constructor method reference and returns a stream of constructed children.

Document instances are typically short-lived objects that are recreated every time they are used. References to other instances than the root should therefore not be stored outside the tree.

Since:

2.3

Author:

Emil Forsund

Field Summary

Fields

Modifier and Type	Field and Description
static Class<List<Map<String,Object>>>	DOCUMENT_LIST_TYPE

Method Summary

Modifier and Type	Method and Description
default Stream<Document>	ancestors() Returns a Stream of every ancestor to this Document, beginning with the first ancestor (the root) and ending with the parent of this Document.
Stream<? extends Document>	children() Returns a Stream of child documents, instantiated using the default document implementation.
default <P extends Document,T extends Document> Stream<T>	children(String key, BiFunction<P,Map<String,Object>,T> constructor) Returns the children on the specified key, instantiated using the specified constructor.
default MapStream<String,Map<String,Object>>	childrenByKey() Returns a Stream of child documents, instantiated using the default document implementation and organized by key.
Optional<Object>	get(String key) Returns the value mapped to the specified key, or an empty Optional if no value was found.
OptionalBoolean	getAsBoolean(String key) Returns the boolean mapped to the specified key, or an empty OptionalBoolean if no value was found.
OptionalDouble	getAsDouble(String key) Returns the double mapped to the specified key, or an empty OptionalDouble if no value was found.
OptionalInt	getAsInt(String key) Returns the int mapped to the specified key, or an empty OptionalInt if no value was found.
OptionalLong	getAsLong(String key) Returns the long mapped to the specified key, or an empty OptionalLong if no value was found.
Optional<String>	getAsString(String key) Returns the String mapped to the specified key, or an empty Optional if no value was found.
Map<String,Object>	getData() Returns the raw data-map used in this Document.
Optional<? extends Document>	getParent() Returns the parent of this Document or Optional.empty() if the Document does not have a parent.
void	put(String key, Object value) Stores the specified value on the specified key in this document.
default MapStream<String,Object>	stream() Returns a key-value stream of the data contained in this Document.

Field Detail

DOCUMENT_LIST_TYPE

static final Class<List<Map<String,Object>>> DOCUMENT_LIST_TYPE

Method Detail

getParent

Optional<? extends Document> getParent()

Returns the parent of this Document or Optional.empty() if the Document does not have a parent.

Returns:

the parent

getData

Map<String,Object> getData()

Returns the raw data-map used in this Document.

Returns:

the raw map

get

Optional<Object> get(String key)

Returns the value mapped to the specified key, or an empty Optional if no value was found.

Parameters:

key - the key

Returns:

the mapped value or an empty Optional

getAsBoolean

OptionalBoolean getAsBoolean(String key)
                      throws ClassCastException

Returns the boolean mapped to the specified key, or an empty OptionalBoolean if no value was found. If a value was found but couldn't be parsed into a boolean, a ClassCastException will be thrown.

Parameters:

key - the key

Returns:

the mapped value or an empty OptionalBoolean

Throws:

ClassCastException - if the mapped value was not a Boolean

getAsLong

OptionalLong getAsLong(String key)
                throws ClassCastException

Returns the long mapped to the specified key, or an empty OptionalLong if no value was found. If a value was found but couldn't be parsed into a long, a ClassCastException will be thrown.

Parameters:

key - the key

Returns:

the mapped value or an empty OptionalLong

Throws:

ClassCastException - if the mapped value was not a Long

getAsDouble

OptionalDouble getAsDouble(String key)
                    throws ClassCastException

Returns the double mapped to the specified key, or an empty OptionalDouble if no value was found. If a value was found but couldn't be parsed into a double, a ClassCastException will be thrown.

Parameters:

key - the key

Returns:

the mapped value or an empty OptionalDouble

Throws:

ClassCastException - if the mapped value was not a Double

getAsInt

OptionalInt getAsInt(String key)
              throws ClassCastException

Returns the int mapped to the specified key, or an empty OptionalInt if no value was found. If a value was found but couldn't be parsed into a int, a ClassCastException will be thrown.

Parameters:

key - the key

Returns:

the mapped value or an empty OptionalInt

Throws:

ClassCastException - if the mapped value was not a Integer

getAsString

Optional<String> getAsString(String key)
                      throws ClassCastException

Returns the String mapped to the specified key, or an empty Optional if no value was found. If a value was found but couldn't be parsed into a String, a ClassCastException will be thrown.

Parameters:

key - the key

Returns:

the mapped value or an empty Optional

Throws:

ClassCastException - if the mapped value was not a String

put

void put(String key,
         Object value)

Stores the specified value on the specified key in this document. If a value was already mapped to that key, it will be overwritten.

Parameters:

key - the key to store the value on

value - the value to store

stream

default MapStream<String,Object> stream()

Returns a key-value stream of the data contained in this Document.

Returns:

the key-value pairs

children

default <P extends Document,T extends Document> Stream<T> children(String key,
                                                                   BiFunction<P,Map<String,Object>,T> constructor)

Returns the children on the specified key, instantiated using the specified constructor. This instance will be used as parent to the constructor.

Type Parameters:

P - the parent type

T - the child type

Parameters:

key - the key

constructor - the child constructor to use

Returns:

a stream of constructed children

See Also:

children(), childrenByKey()

children

Stream<? extends Document> children()

Returns a Stream of child documents, instantiated using the default document implementation. This method will consider every value that is a List of Map instances a child. To get a stream with the key-side preserved, use childrenByKey().

Returns:

a stream of every child

See Also:

children(String, BiFunction), childrenByKey()

childrenByKey

default MapStream<String,Map<String,Object>> childrenByKey()

Returns a Stream of child documents, instantiated using the default document implementation and organized by key. This method will consider every value that is a List of Map instances a child. To get a stream without the key-side, use children().

Returns:

a stream of every child mapped by key

See Also:

children(), children(String, BiFunction)

ancestors

default Stream<Document> ancestors()

Returns a Stream of every ancestor to this Document, beginning with the first ancestor (the root) and ending with the parent of this Document.

This stream can typically not be short-circuited and operations on it will therefore have a complexity of O(n).

Returns:

a stream of ancestors, from the root to the parent