Top Fields Constructors Methods
com.vladsch.flexmark.util.data

public Class DataSet

extends Object
implements DataHolder
Class Inheritance
All Implemented Interfaces
com.vladsch.flexmark.util.data.DataHolder, com.vladsch.flexmark.util.data.MutableDataSetter
Known Direct Subclasses
com.vladsch.flexmark.util.data.MutableDataSet, com.vladsch.flexmark.util.data.ScopedDataSet
Imports
org.jetbrains.annotations.NotNull, .Nullable, java.util.*

Field Summary

Modifier and TypeField and Description
protected final HashMap<DataKeyBase<?>, Object>
private static final ArrayList<DataKeyAggregator>

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public @NotNull DataHolder

Returns:

resulting data holder
aggregate
()

Apply aggregate action to data and return result

public static @NotNull DataHolder

Returns:

resulting options with aggregate actions applied and removed from set
aggregate
(@Nullable DataHolder
options with aggregate actions already applied, no aggregate action keys are expected or checked
other
,
@Nullable DataHolder
overrides which may contain aggregate actions
overrides
)

Aggregate two sets of options by aggregating their aggregate action keys then applying those actions on the resulting collection

public static @NotNull DataHolder

Returns:

resulting options where aggregate action keys were aggregated but not applied
aggregateActions
(@NotNull DataHolder
first set of options
other
,
@NotNull DataHolder
overrides on options
overrides
)

aggregate actions of two data sets, actions not applied

public boolean
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public @NotNull Map<? extends DataKeyBase<?>, Object>
public @NotNull Collection<? extends DataKeyBase<?>>
public @Nullable Object
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

pack-priv static boolean
pack-priv static boolean
public static @NotNull DataSet
merge(@NotNull DataHolder... dataHolders)

public static void
public @NotNull DataSet
public @NotNull DataSet
public @NotNull MutableDataSet
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

dataSetback to summary
protected final HashMap<DataKeyBase<?>, Object> dataSet
ourDataKeyAggregatorsback to summary
private static final ArrayList<DataKeyAggregator> ourDataKeyAggregators

Constructor Detail

DataSetback to summary
public DataSet()
DataSetback to summary
public DataSet(@Nullable DataHolder other)

Method Detail

aggregateback to summary
public @NotNull DataHolder aggregate()

Apply aggregate action to data and return result

Returns:@NotNull DataHolder

resulting data holder

Annotations
@NotNull
aggregateback to summary
public static @NotNull DataHolder aggregate(@Nullable DataHolder other, @Nullable DataHolder overrides)

Aggregate two sets of options by aggregating their aggregate action keys then applying those actions on the resulting collection

Parameters
other:@Nullable DataHolder

options with aggregate actions already applied, no aggregate action keys are expected or checked

overrides:@Nullable DataHolder

overrides which may contain aggregate actions

Returns:@NotNull DataHolder

resulting options with aggregate actions applied and removed from set

Annotations
@NotNull
aggregateActionsback to summary
public static @NotNull DataHolder aggregateActions(@NotNull DataHolder other, @NotNull DataHolder overrides)

aggregate actions of two data sets, actions not applied

Parameters
other:@NotNull DataHolder

first set of options

overrides:@NotNull DataHolder

overrides on options

Returns:@NotNull DataHolder

resulting options where aggregate action keys were aggregated but not applied

Annotations
@NotNull
containsback to summary
public boolean contains(@NotNull DataKeyBase<?> key)
Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAllback to summary
public @NotNull Map<? extends DataKeyBase<?>, Object> getAll()

Implements com.vladsch.flexmark.util.data.DataHolder.getAll.

Annotations
@Override
@NotNull
getKeysback to summary
public @NotNull Collection<? extends DataKeyBase<?>> getKeys()

Implements com.vladsch.flexmark.util.data.DataHolder.getKeys.

Annotations
@Override
@NotNull
getOrComputeback to summary
public @Nullable Object getOrCompute(@NotNull DataKeyBase<?> key, @NotNull DataValueFactory<?> factory)
Annotations
@Override
@Nullable
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
invokeSetContainsback to summary
pack-priv static boolean invokeSetContains(@Nullable Set<Class<?>> invokeSet, @NotNull DataKeyAggregator aggregator)
isAggregatorRegisteredback to summary
pack-priv static boolean isAggregatorRegistered(@NotNull DataKeyAggregator keyAggregator)
mergeback to summary
public static @NotNull DataSet merge(@NotNull DataHolder... dataHolders)
Annotations
@NotNull
registerDataKeyAggregatorback to summary
public static void registerDataKeyAggregator(@NotNull DataKeyAggregator keyAggregator)
toDataSetback to summary
public @NotNull DataSet toDataSet()

Overrides default com.vladsch.flexmark.util.data.DataHolder.toDataSet.

Annotations
@Override
@NotNull
toImmutableback to summary
public @NotNull DataSet toImmutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toImmutable.

Annotations
@NotNull
@Override
toMutableback to summary
public @NotNull MutableDataSet toMutable()

Implements com.vladsch.flexmark.util.data.DataHolder.toMutable.

Annotations
@NotNull
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override