com.vladsch.flexmark.util.data

Interface DataHolder

All Superinterfaces:

MutableDataSetter

All Known Subinterfaces:

MutableDataHolder

All Known Implementing Classes:

DataSet, MutableDataSet, MutableScopedDataSet, ScopedDataSet

public interface DataHolder
extends MutableDataSetter

Field Summary

Fields

Modifier and Type	Field and Description
static DataHolder	NULL

Method Summary

Modifier and Type	Method and Description
boolean	contains(@NotNull DataKeyBase<?> key)
default <T> T	get(@NotNull DataKey<T> key) Deprecated.
@NotNull Map<? extends DataKeyBase<?>,Object>	getAll()
@NotNull Collection<? extends DataKeyBase<?>>	getKeys()
Object	getOrCompute(@NotNull DataKeyBase<?> key, @NotNull DataValueFactory<?> factory) Get key if it exists or compute using supplier
default @NotNull MutableDataHolder	setIn(@NotNull MutableDataHolder dataHolder)
default @NotNull DataSet	toDataSet()
@NotNull DataHolder	toImmutable()
@NotNull MutableDataHolder	toMutable()

Field Detail

NULL

static final DataHolder NULL

Method Detail

getAll

@NotNull
@NotNull Map<? extends DataKeyBase<?>,Object> getAll()

getKeys

@NotNull
@NotNull Collection<? extends DataKeyBase<?>> getKeys()

contains

boolean contains(@NotNull
                 @NotNull DataKeyBase<?> key)

get

@Deprecated
 @Nullable
default <T> T get(@NotNull
                                         @NotNull DataKey<T> key)

Deprecated.

Type Parameters:

T - Type returned by key

Parameters:

key - data key

Returns:

Use key.get(dataHolder) instead

setIn

@NotNull
default @NotNull MutableDataHolder setIn(@NotNull
                                                  @NotNull MutableDataHolder dataHolder)

Specified by:

setIn in interface MutableDataSetter

getOrCompute

Object getOrCompute(@NotNull
                    @NotNull DataKeyBase<?> key,
                    @NotNull
                    @NotNull DataValueFactory<?> factory)

Get key if it exists or compute using supplier

Method used by DataKey classes to access data.

NOTE: MutableDataHolders will compute an absent key and add it to its dataSet. DataHolders will return computed value but not change contained dataSet because they are immutable. So value will be computed every time it is requested.

Parameters:

key - data key

factory - factory taking this data holder and computing/providing default value

Returns:

object value for the key

toMutable

@NotNull
@NotNull MutableDataHolder toMutable()

toImmutable

@NotNull
@NotNull DataHolder toImmutable()

toDataSet

@NotNull
default @NotNull DataSet toDataSet()