Package io.deephaven.kv

Interface KeyPathContextDescription

All Known Implementing Classes:

AtomicDirectoryContext.MetaDescription, DHContext.Description, FileContext.Description, KeyPathContextDescription.Dynamic, KeyPathContextDescription.Terminal, MetaInfoContext.Description, PropsContext.Description, RoutingFileContext.Description, SchemaNamespaceAttributesContext.Description, SchemaNamespaceContext.Description, UpdateInfoContext.Description

public interface KeyPathContextDescription

Describes the structure of a KeyPathContext. Currently, it aids in helping developers grok the structure of statically defined KeyPathContexts, but could eventually be used to help clients understand the structure they are updating.

The description is only able to capture the static entries at the moment, as we maintain a strong separation between model and data. It's could be possible in the future to extend the notion of a "description" to include dynamic descriptions - ie, descriptions that depend on actual data present at a given KeyPath - but that is beyond the intended scope ATM.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	KeyPathContextDescription.Dynamic	A dynamic description indicates that the "description" of the KeyPathContext can not be fully defined statically, and depends on the underlying data.
static class	KeyPathContextDescription.Entry<T extends KeyPathContext,Resolver>	An Entry is a static description of a KeyPathContext.
static enum	KeyPathContextDescription.Terminal	A terminal description indicates that there is no further sub-structuring of the KeyPathContext.

Method Summary

Modifier and Type	Method	Description
default KeyPathContextDescription	and(KeyPathContextDescription other)
static KeyPathContextDescription	dynamic()
List<KeyPathContextDescription.Entry>	getEntries()
boolean	hasDynamicDescription()
default boolean	isTerminal()
static KeyPathContextDescription	terminal()

Method Details

terminal

static KeyPathContextDescription terminal()

dynamic

static KeyPathContextDescription dynamic()

getEntries

List<KeyPathContextDescription.Entry> getEntries()

hasDynamicDescription

boolean hasDynamicDescription()

isTerminal

default boolean isTerminal()

and

default KeyPathContextDescription and(KeyPathContextDescription other)