Package com.vladsch.flexmark.util.data

Class DataKeyBase<T>

java.lang.Object

com.vladsch.flexmark.util.data.DataKeyBase<T>

All Implemented Interfaces:

MutableDataValueSetter<T>

Direct Known Subclasses:

DataKey, NullableDataKey

public abstract class DataKeyBase<T>
extends Object
implements MutableDataValueSetter<T>

Constructor Summary

Constructors

Constructor	Description
DataKeyBase(@NotNull String name, @NotNull DataKeyBase<T> defaultKey)	Creates a NullableDataKey with a dynamic default value taken from a value of another key
DataKeyBase(@NotNull String name, T defaultValue)
DataKeyBase(@NotNull String name, T defaultValue, @NotNull DataValueFactory<T> factory)	Creates a NullableDataKey with a computed default value and a provided default value when data holder is null.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compare only by address.
T	get(@Nullable DataHolder holder)
T	getDefaultValue()
T	getDefaultValue(@NotNull DataHolder holder)
@NotNull DataValueFactory<T>	getFactory()
T	getFrom(@Nullable DataHolder holder)	Deprecated. use get
@NotNull String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vladsch.flexmark.util.data.MutableDataValueSetter

set

Constructor Detail

DataKeyBase

public DataKeyBase(@NotNull
                   @NotNull String name,
                   T defaultValue,
                   @NotNull
                   @NotNull DataValueFactory<T> factory)

Creates a NullableDataKey with a computed default value and a provided default value when data holder is null.

Use this constructor to ensure that factory is never called with null data holder value

Parameters:

name - See getName().

defaultValue - default to use when data holder is null

factory - data value factory for creating a new default value for the key for a non-null data holder

DataKeyBase

public DataKeyBase(@NotNull
                   @NotNull String name,
                   @NotNull
                   @NotNull DataKeyBase<T> defaultKey)

Creates a NullableDataKey with a dynamic default value taken from a value of another key

does not cache the returned default value but will always delegate to another key until this key gets its own value set.

Parameters:

name - See getName().

defaultKey - The NullableDataKey to take the default value from at time of construction.

DataKeyBase

public DataKeyBase(@NotNull
                   @NotNull String name,
                   T defaultValue)

Method Detail

getName

@NotNull
public @NotNull String getName()

getFactory

@NotNull
public @NotNull DataValueFactory<T> getFactory()

getDefaultValue

public T getDefaultValue()

getDefaultValue

public T getDefaultValue(@NotNull
                         @NotNull DataHolder holder)

get

public T get(@Nullable
             @Nullable DataHolder holder)

getFrom

@Deprecated
public final T getFrom(@Nullable
                       @Nullable DataHolder holder)

Deprecated.

use get

Parameters:

holder - data holder

Returns:

return default value if holder is null, current value in holder or compute a new value

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Compare only by address. Every key instance is unique

Overrides:

equals in class Object

Parameters:

o - other

Returns:

true if equal

hashCode

public final int hashCode()

Overrides:

hashCode in class Object