com.vladsch.flexmark.util.options

Class MutableDataSet

java.lang.Object

com.vladsch.flexmark.util.options.DataSet

com.vladsch.flexmark.util.options.MutableDataSet

All Implemented Interfaces:

DataHolder, MutableDataHolder, MutableDataSetter

public class MutableDataSet
extends DataSet
implements MutableDataHolder

Field Summary

Fields inherited from class com.vladsch.flexmark.util.options.DataSet

dataSet

Constructor Summary

Constructors

Constructor and Description
MutableDataSet()
MutableDataSet(DataHolder other)

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.
static MutableDataSet	merge(DataHolder... dataHolders)
<T> MutableDataSet	remove(DataKey<T> key) Remove the stored value for the key, used to force to default or to force recompute
<T> MutableDataSet	set(DataKey<T> key, T value) Store the given value for the key
MutableDataSet	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
DataHolder	toImmutable()
MutableDataSet	toMutable()

Methods inherited from class com.vladsch.flexmark.util.options.DataSet

contains, getAll, keySet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

contains, getAll, keySet

Constructor Detail

MutableDataSet

public MutableDataSet()

MutableDataSet

public MutableDataSet(DataHolder other)

Method Detail

set

public <T> MutableDataSet set(DataKey<T> key,
                              T value)

Description copied from interface: MutableDataHolder

Store the given value for the key

Specified by:

set in interface MutableDataHolder

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

setFrom

public MutableDataHolder setFrom(MutableDataSetter dataSetter)

Description copied from interface: MutableDataHolder

Store the given value for the key

Specified by:

setFrom in interface MutableDataHolder

Parameters:

dataSetter - data setter which will set values

Returns:

mutable data holder for chained calls

setAll

public MutableDataSet setAll(DataHolder other)

Description copied from interface: MutableDataHolder

Copy all values from one data holder to this data holder

Specified by:

setAll in interface MutableDataHolder

Parameters:

other - data holder from which to copy all values

Returns:

mutable data holder for chained calls

setIn

public MutableDataHolder setIn(MutableDataHolder dataHolder)

Description copied from interface: MutableDataHolder

Set options in gven mutable data hoer

Specified by:

setIn in interface MutableDataHolder

Specified by:

setIn in interface MutableDataSetter

Parameters:

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

Returns:

dataHolder

get

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

Description copied from interface: MutableDataHolder

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

Specified by:

get in interface MutableDataHolder

Overrides:

get in class DataSet

Parameters:

key - data key

Returns:

return stored value or newly created value

remove

public <T> MutableDataSet remove(DataKey<T> key)

Description copied from interface: MutableDataHolder

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

Specified by:

remove in interface MutableDataHolder

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

getOrCompute

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

Description copied from interface: MutableDataHolder

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.

Specified by:

getOrCompute in interface MutableDataHolder

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.

merge

public static MutableDataSet merge(DataHolder... dataHolders)

toMutable

public MutableDataSet toMutable()

Specified by:

toMutable in interface DataHolder

Overrides:

toMutable in class DataSet

toImmutable

public DataHolder toImmutable()

Specified by:

toImmutable in interface DataHolder

Overrides:

toImmutable in class DataSet

clear

public MutableDataHolder clear()

Description copied from interface: MutableDataHolder

clear all options out of the data set

Specified by:

clear in interface MutableDataHolder

Returns:

mutable data holder for chained calls