crux.api

Class CruxDocument

java.lang.Object

crux.api.CruxDocument

public final class CruxDocument
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CruxDocument.Builder

Method Summary

Modifier and Type	Method and Description
static CruxDocument	build(java.lang.Object id, java.util.function.Consumer<CruxDocument.Builder> f)
static CruxDocument.Builder	builder(java.lang.Object id)
static CruxDocument	create(java.lang.Object id) Creates a new CruxDocument with just an ID key.
static CruxDocument	create(java.lang.Object id, java.util.Map<java.lang.String,java.lang.Object> data)
static CruxDocument	createFunction(java.lang.Object id, java.lang.String rawFunction) Static factory to create a Crux transaction function document.
boolean	equals(java.lang.Object o)
static CruxDocument	factory(clojure.lang.IPersistentMap input) Creates a CruxDocument from a Clojure map.
java.lang.Object	get(java.lang.String key)
java.lang.Object	getId()
int	hashCode()
CruxDocument	minus(java.lang.String key)
CruxDocument	minusAll(java.lang.Iterable<java.lang.String> keys)
CruxDocument	plus(java.lang.String key, java.lang.Object value)
CruxDocument	plusAll(java.util.Map<java.lang.String,java.lang.Object> entries)
clojure.lang.IPersistentMap	toMap() Not intended for public use, may be removed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

public static CruxDocument build(java.lang.Object id,
                                 java.util.function.Consumer<CruxDocument.Builder> f)

builder

public static CruxDocument.Builder builder(java.lang.Object id)

factory

public static CruxDocument factory(clojure.lang.IPersistentMap input)

Creates a CruxDocument from a Clojure map. Not intended for public use, may be removed.

Parameters:

input -

create

public static CruxDocument create(java.lang.Object id)

Creates a new CruxDocument with just an ID key. See CruxDocument for valid ID types

Parameters:

id -

Returns:

a new CruxDocument

createFunction

public static CruxDocument createFunction(java.lang.Object id,
                                          java.lang.String rawFunction)

Static factory to create a Crux transaction function document.

Parameters:

id - the id of the transaction function

rawFunction - the function body, as a Clojure-code string.

Returns:

the function document, suitable for use in Transaction.Builder.put(CruxDocument)

create

public static CruxDocument create(java.lang.Object id,
                                  java.util.Map<java.lang.String,java.lang.Object> data)

plus

public CruxDocument plus(java.lang.String key,
                         java.lang.Object value)

Returns:

a new CruxDocument with the key/value added

plusAll

public CruxDocument plusAll(java.util.Map<java.lang.String,java.lang.Object> entries)

Returns:

a new CruxDocument with the entries added

minus

public CruxDocument minus(java.lang.String key)

Returns:

a new CruxDocument with the key removed

minusAll

public CruxDocument minusAll(java.lang.Iterable<java.lang.String> keys)

Returns:

a new CruxDocument with the keys removed

get

public java.lang.Object get(java.lang.String key)

getId

public java.lang.Object getId()

toMap

public clojure.lang.IPersistentMap toMap()

Not intended for public use, may be removed.

Returns:

this document as a Clojure map.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object