com.vladsch.flexmark.util.options

Interface MutableDataHolder

All Superinterfaces:

DataHolder, MutableDataSetter

All Known Implementing Classes:

Document, MutableDataSet

public interface MutableDataHolder
extends DataHolder, MutableDataSetter

Method Summary

Modifier and Type	Method and Description
MutableDataHolder	clear() clear all options out of the data set
<T> T	get(DataKey<T> key) Get the given key, if it does not exist then use the key's factory to create a new value and put it into the collection so that the following get of the same key will find a value
<T> T	getOrCompute(DataKey<T> key, DataValueFactory<T> factory) Will return the value previously set or generate a new value using the given factory.
<T> MutableDataHolder	remove(DataKey<T> key) Remove the stored value for the key, used to force to default or to force recompute
<T> MutableDataHolder	set(DataKey<T> key, T value) Store the given value for the key
MutableDataHolder	setAll(DataHolder other) Copy all values from one data holder to this data holder
MutableDataHolder	setFrom(MutableDataSetter dataSetter) Store the given value for the key
MutableDataHolder	setIn(MutableDataHolder dataHolder) Set options in gven mutable data hoer

Methods inherited from interface com.vladsch.flexmark.util.options.DataHolder

contains, getAll, keySet, toImmutable, toMutable

Method Detail

get

<T> T get(DataKey<T> key)

Get the given key, if it does not exist then use the key's factory to create a new value and put it into the collection so that the following get of the same key will find a value

Specified by:

get in interface DataHolder

Parameters:

key - data key

Returns:

return stored value or newly created value

set

<T> MutableDataHolder set(DataKey<T> key,
                          T value)

Store the given value for the key

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key

value - value to store

Returns:

mutable data holder for chained calls

remove

<T> MutableDataHolder remove(DataKey<T> key)

Remove the stored value for the key, used to force to default or to force recompute

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key to remove

Returns:

mutable data holder for chained calls

setFrom

MutableDataHolder setFrom(MutableDataSetter dataSetter)

Store the given value for the key

Parameters:

dataSetter - data setter which will set values

Returns:

mutable data holder for chained calls

setAll

MutableDataHolder setAll(DataHolder other)

Copy all values from one data holder to this data holder

Parameters:

other - data holder from which to copy all values

Returns:

mutable data holder for chained calls

setIn

MutableDataHolder setIn(MutableDataHolder dataHolder)

Set options in gven mutable data hoer

Specified by:

setIn in interface MutableDataSetter

Parameters:

dataHolder - data holder where to copy options from this data holder

Returns:

dataHolder

getOrCompute

<T> T getOrCompute(DataKey<T> key,
                   DataValueFactory<T> factory)

Will return the value previously set or generate a new value using the given factory. NOTE: if a new value is generated it will be stored for the given key so that subsequent calls with the same parameters will return the same value as the first call that generated the new value.

Type Parameters:

T - data type of the data referred by the key

Parameters:

key - data key identifying the data

factory - data value factory to use if the data referred by the key is not set

Returns:

data stored for the key or a value generated by the value factory.

clear

MutableDataHolder clear()

clear all options out of the data set

Returns:

mutable data holder for chained calls