Package io.deephaven.kv

Interface KeyPathContext

All Superinterfaces:

Context

All Known Subinterfaces:

GetResponseParser<X>

All Known Implementing Classes:

AclContext, AtomicDirectoryContext, ConfigContext, ConfigFileContext, DataContext, DHContext, EnumContext, FileContext, FilesContext, InstantContext, KeyPathContextBase, KeyPathPrefixContext, KeyPathSimpleValue, MetaInfoContext, ModContext, OptionalLongContext, PersistentQueriesContext, PersistentQueryContext, PropsContext, RawValueContext, RoutingFileContext, SchemaContext, SchemaNamespaceAttributesContext, SchemaNamespaceContext, SchemaNamespaceTablesContext, SchemaTableContext, StringContext, SystemContext, UpdateCountContext, UpdateInfoContext

public interface KeyPathContext
extends Context

KeyPathContext is a Context where equivalence is defined solely on the basis of getPath(). Implementations can NOT have any additional stateful data. Ie, the objects are immutable.

The main idea is that each KeyPathContext class has a structured set of conventions that build up the model for a given getPath().

KeyPathContextBase is a provided abstract implementation.

Method Summary

Modifier and Type	Method	Description
KeyPathContextDescription	getDescription()	Get the description.
KeyPath	getPath()	Get the key path.
default <T extends KeyPathContext> T	resolve(KeyPathContextDescription.Entry<T,KeyPath> entry)	A fluent equivalent to entry.resolveFrom(getPath()).

Method Details

getPath

KeyPath getPath()

Get the key path.

getDescription

KeyPathContextDescription getDescription()

Get the description. The description doesn't currently serve any runtime purpose, but it helps ensure that we document each KeyPathContext appropriately.

resolve

default <T extends KeyPathContext> T resolve(KeyPathContextDescription.Entry<T,KeyPath> entry)

A fluent equivalent to entry.resolveFrom(getPath()).

Callers should consider caching this value.

Type Parameters:

T - the KeyPathContext type

Parameters:

entry - the entry

Returns:

the KeyPathContext