jakarta.nosql.document

Interface Document

public interface Document

A Document Collection Entity unit, it is a tuple (pair) that consists of a key-value pair, where the key is mapped to a value.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Document.DocumentProvider A provider of Document where it will create from two parameters: The first one is the name of column The second one is the information of column

Method Summary

Modifier and Type	Method and Description
Object	get() Alias to Value.get()
<T> T	get(Class<T> clazz) Alias to Value.get(Class)
<T> T	get(TypeSupplier<T> typeSupplier) Alias to Value.get(TypeSupplier)
String	getName() The column's name
Value	getValue() the column's value
static <V> Document	of(String name, V value) Creates a document instance

Method Detail

of

static <V> Document of(String name,
                       V value)

Creates a document instance

Type Parameters:

V - the value type

Parameters:

name - - document's name

value - - document's value

Returns:

a document instance

Throws:

NullPointerException - when there is any null parameter

See Also:

Documents

getName

String getName()

The column's name

Returns:

name

getValue

Value getValue()

the column's value

Returns:

Value

get

<T> T get(Class<T> clazz)

Alias to Value.get(Class)

Type Parameters:

T - Value.get(Class)

Parameters:

clazz - Value.get(Class)

Returns:

Value.get(Class)

Throws:

NullPointerException - see Value.get(Class)

UnsupportedOperationException - see Value.get(Class)

get

<T> T get(TypeSupplier<T> typeSupplier)

Alias to Value.get(TypeSupplier)

Type Parameters:

T - Value.get(TypeSupplier)

Parameters:

typeSupplier - Value.get(TypeSupplier)

Returns:

Value.get(TypeSupplier)

Throws:

NullPointerException - see Value.get(TypeSupplier)

UnsupportedOperationException - see Value.get(TypeSupplier)

get

Object get()

Alias to Value.get()

Returns:

Value.get()