Index (bosk-mongo 0.0.107 API)

A B C D E F G H I M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

actual() - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Returns the value of the actual record component.

B

BsonComparator - Class in io.vena.bosk.drivers.mongo.status
BsonComparator() - Constructor for class io.vena.bosk.drivers.mongo.status.BsonComparator
bsonPath() - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Returns the value of the bsonPath record component.
bsonPath() - Method in record class io.vena.bosk.drivers.mongo.status.NodeMissing: Returns the value of the bsonPath record component.
bsonPath() - Method in record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference: Returns the value of the bsonPath record component.
bsonPath() - Method in interface io.vena.bosk.drivers.mongo.status.SomeDifference
bsonPath() - Method in record class io.vena.bosk.drivers.mongo.status.UnexpectedNode: Returns the value of the bsonPath record component.
BsonPlugin - Class in io.vena.bosk.drivers.mongo
BsonPlugin() - Constructor for class io.vena.bosk.drivers.mongo.BsonPlugin
build(BoskInfo<RR>, BoskDriver<RR>) - Method in interface io.vena.bosk.drivers.mongo.MongoDriver.MongoDriverFactory

C

close() - Method in interface io.vena.bosk.drivers.mongo.MongoDriver: Frees up resources used by this driver and leaves it unusable.
codecProviderFor(BoskInfo<R>) - Method in class io.vena.bosk.drivers.mongo.BsonPlugin: Note that the CodecProvider is Class-based, so it has anemic type information for generics due to type erasure.
CREATE_IF_ABSENT - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode: If a manifest document doesn't exist, we'll create one.

D

difference() - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Returns the value of the difference record component.
difference(BsonValue, BsonValue) - Method in class io.vena.bosk.drivers.mongo.status.BsonComparator
Difference - Interface in io.vena.bosk.drivers.mongo.status
DISCONNECT - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode: If the database state can't be loaded during BoskDriver.initialRoot(java.lang.reflect.Type), use the downstream driver's initial state and proceed in disconnected mode.

E

EARNEST - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode: Unused documents are always deleted before the end of the transaction.
EmptyNode() - Constructor for record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode: Creates an instance of a EmptyNode record class.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.Manifest: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.PandoFormat: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.NodeMissing: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.NoDifference: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class io.vena.bosk.drivers.mongo.status.UnexpectedNode: Indicates whether some other object is "equal to" this one.
error() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Returns the value of the error record component.
examples() - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Returns the value of the examples record component.
expected() - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Returns the value of the expected record component.
Experimental() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings.Experimental

F

factory(MongoClientSettings, MongoDriverSettings, BsonPlugin) - Static method in interface io.vena.bosk.drivers.mongo.MongoDriver
FAIL - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode: If the database state can't be loaded during BoskDriver.initialRoot(java.lang.reflect.Type), throw an exception.
FailedSessionException - Exception in io.vena.bosk.drivers.mongo: Indicates a call to MongoClient.startSession() threw an exception, leaving us unable to interact with the database.
FailedSessionException(String) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException
FailedSessionException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException
FailedSessionException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FailedSessionException
forFormat(MongoDriverSettings.DatabaseFormat) - Static method in record class io.vena.bosk.drivers.mongo.Manifest
FormatMisconfigurationException - Exception in io.vena.bosk.drivers.mongo: Indicates that an error was found in a DatabaseFormat object.
FormatMisconfigurationException(String) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException
FormatMisconfigurationException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException
FormatMisconfigurationException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.FormatMisconfigurationException
forPando(PandoFormat) - Static method in record class io.vena.bosk.drivers.mongo.Manifest
forSequoia() - Static method in record class io.vena.bosk.drivers.mongo.Manifest

G

getCodec(Type, Class<T>, CodecRegistry, BoskInfo<R>) - Method in class io.vena.bosk.drivers.mongo.BsonPlugin: Like codecProviderFor(boskInfo).get(targetType, registry) except this works more broadly because it can accept a ParameterizedType for generic classes.
graftPoints() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat: Returns the value of the graftPoints record component.

H

hashCode() - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.Manifest: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.NodeMissing: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.NoDifference: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Returns a hash code value for this object.
hashCode() - Method in record class io.vena.bosk.drivers.mongo.status.UnexpectedNode: Returns a hash code value for this object.
HASTY - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode: Unused documents may be left behind, to be cleaned up later.

I

InitialRootFailureException - Exception in io.vena.bosk.drivers.mongo: Thrown from BoskDriver.initialRoot(java.lang.reflect.Type) if the initial root can't be loaded from the database and MongoDriverSettings.InitialDatabaseUnavailableMode.FAIL is in effect.
InitialRootFailureException(String) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException
InitialRootFailureException(String, Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException
InitialRootFailureException(Throwable) - Constructor for exception io.vena.bosk.drivers.mongo.InitialRootFailureException
io.vena.bosk.drivers.mongo - package io.vena.bosk.drivers.mongo
io.vena.bosk.drivers.mongo.status - package io.vena.bosk.drivers.mongo.status
isAllClear() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus
isIdentical() - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus

M

manifest() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Returns the value of the manifest record component.
Manifest - Record Class in io.vena.bosk.drivers.mongo: Defines the format of the manifest document, which is stored in the database to describe the database contents.
Manifest(Integer, Optional<Manifest.EmptyNode>, Optional<PandoFormat>) - Constructor for record class io.vena.bosk.drivers.mongo.Manifest: Creates an instance of a Manifest record class.
Manifest.EmptyNode - Record Class in io.vena.bosk.drivers.mongo
ManifestStatus - Record Class in io.vena.bosk.drivers.mongo.status
ManifestStatus(Manifest, Manifest) - Constructor for record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Creates an instance of a ManifestStatus record class.
MAX_DIFFERENCES - Static variable in class io.vena.bosk.drivers.mongo.status.BsonComparator
MongoDriver<R extends io.vena.bosk.StateTreeNode> - Interface in io.vena.bosk.drivers.mongo: A BoskDriver that maintains the bosk state in a MongoDB database.
MongoDriver.MongoDriverFactory<RR extends io.vena.bosk.StateTreeNode> - Interface in io.vena.bosk.drivers.mongo
MongoDriverSettings - Class in io.vena.bosk.drivers.mongo
MongoDriverSettings() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings
MongoDriverSettings.DatabaseFormat - Interface in io.vena.bosk.drivers.mongo
MongoDriverSettings.Experimental - Class in io.vena.bosk.drivers.mongo: Settings with no guarantee of long-term support.
MongoDriverSettings.InitialDatabaseUnavailableMode - Enum Class in io.vena.bosk.drivers.mongo
MongoDriverSettings.ManifestMode - Enum Class in io.vena.bosk.drivers.mongo
MongoDriverSettings.OrphanDocumentMode - Enum Class in io.vena.bosk.drivers.mongo
MongoDriverSettings.SequoiaFormat - Class in io.vena.bosk.drivers.mongo
MongoDriverSettings.Testing - Class in io.vena.bosk.drivers.mongo: Settings not meant to be used in production.
MongoStatus - Record Class in io.vena.bosk.drivers.mongo.status: Info about the state of the database, highlighting how it differs from the desired state.
MongoStatus(String, ManifestStatus, StateStatus) - Constructor for record class io.vena.bosk.drivers.mongo.status.MongoStatus: Creates an instance of a MongoStatus record class.
MultipleDifferences - Record Class in io.vena.bosk.drivers.mongo.status
MultipleDifferences(String, List<Difference>) - Constructor for record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Creates an instance of a MultipleDifferences record class.

N

NodeMissing - Record Class in io.vena.bosk.drivers.mongo.status
NodeMissing(String) - Constructor for record class io.vena.bosk.drivers.mongo.status.NodeMissing: Creates an instance of a NodeMissing record class.
NoDifference - Record Class in io.vena.bosk.drivers.mongo.status
NoDifference() - Constructor for record class io.vena.bosk.drivers.mongo.status.NoDifference: Creates an instance of a NoDifference record class.

O

oneBigDocument() - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat: Differs from Sequoia in that (1) the root document has a different ID, rendering the formats incompatible; and (2) Sequoia is designed not to need multi-document transactions.

P

pando() - Method in record class io.vena.bosk.drivers.mongo.Manifest: Returns the value of the pando record component.
PandoFormat - Record Class in io.vena.bosk.drivers.mongo: A scalable format that stores the bosk state in multiple documents, thereby overcoming MongoDB's 16MB document size limit.
PandoFormat(ListValue<String>) - Constructor for record class io.vena.bosk.drivers.mongo.PandoFormat: Creates an instance of a PandoFormat record class.
prefixed(String, String) - Static method in interface io.vena.bosk.drivers.mongo.status.Difference
PrimitiveDifference - Record Class in io.vena.bosk.drivers.mongo.status
PrimitiveDifference(String) - Constructor for record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference: Creates an instance of a PrimitiveDifference record class.

R

readStatus() - Method in interface io.vena.bosk.drivers.mongo.MongoDriver: Requires a Bosk.ReadContext.
refurbish() - Method in interface io.vena.bosk.drivers.mongo.MongoDriver: Deserializes and re-serializes the entire bosk contents, thus updating the database to match the current serialized format.
revision() - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Returns the value of the revision record component.

S

sequoia() - Method in record class io.vena.bosk.drivers.mongo.Manifest: Returns the value of the sequoia record component.
SEQUOIA - Static variable in interface io.vena.bosk.drivers.mongo.MongoDriverSettings.DatabaseFormat: Simple format that stores the entire bosk state in a single document, and (except for refirbish) doesn't require any multi-document transactions.
sizeInBytes() - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Returns the value of the sizeInBytes record component.
SomeDifference - Interface in io.vena.bosk.drivers.mongo.status
state() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Returns the value of the state record component.
StateStatus - Record Class in io.vena.bosk.drivers.mongo.status
StateStatus(Long, Long, Difference) - Constructor for record class io.vena.bosk.drivers.mongo.status.StateStatus: Creates an instance of a StateStatus record class.

T

Testing() - Constructor for class io.vena.bosk.drivers.mongo.MongoDriverSettings.Testing
toString() - Method in record class io.vena.bosk.drivers.mongo.Manifest.EmptyNode: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.Manifest: Returns a string representation of this record class.
toString() - Method in class io.vena.bosk.drivers.mongo.MongoDriverSettings.SequoiaFormat
toString() - Method in record class io.vena.bosk.drivers.mongo.PandoFormat: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.ManifestStatus: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.NodeMissing: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.NoDifference: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.StateStatus: Returns a string representation of this record class.
toString() - Method in record class io.vena.bosk.drivers.mongo.status.UnexpectedNode: Returns a string representation of this record class.

U

UnexpectedNode - Record Class in io.vena.bosk.drivers.mongo.status
UnexpectedNode(String) - Constructor for record class io.vena.bosk.drivers.mongo.status.UnexpectedNode: Creates an instance of a UnexpectedNode record class.
USE_IF_EXISTS - Enum constant in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode: If a manifest document doesn't exist, we'll assume certain defaults.

V

validate() - Method in class io.vena.bosk.drivers.mongo.MongoDriverSettings
valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.InitialDatabaseUnavailableMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.ManifestMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.vena.bosk.drivers.mongo.MongoDriverSettings.OrphanDocumentMode: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Method in record class io.vena.bosk.drivers.mongo.Manifest: Returns the value of the version record component.

W

with(MongoDriverSettings.DatabaseFormat, Manifest) - Method in record class io.vena.bosk.drivers.mongo.status.MongoStatus
withGraftPoints(String...) - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat
withGraftPoints(Collection<String>) - Static method in record class io.vena.bosk.drivers.mongo.PandoFormat
withPrefix(String) - Method in interface io.vena.bosk.drivers.mongo.status.Difference
withPrefix(String) - Method in record class io.vena.bosk.drivers.mongo.status.MultipleDifferences
withPrefix(String) - Method in record class io.vena.bosk.drivers.mongo.status.NodeMissing
withPrefix(String) - Method in record class io.vena.bosk.drivers.mongo.status.NoDifference
withPrefix(String) - Method in record class io.vena.bosk.drivers.mongo.status.PrimitiveDifference
withPrefix(String) - Method in record class io.vena.bosk.drivers.mongo.status.UnexpectedNode

A B C D E F G H I M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form