com.vladsch.flexmark.util.data.MutableDataHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flexmark-util-data Show documentation
flexmark-java data utility classes
The newest version!
package com.vladsch.flexmark.util.data;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface MutableDataHolder extends DataHolder {
  /**
   * 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
   *
   * @param key data key
   * @return return stored value or newly created value
   * @deprecated use key.get(dataHolder) instead, which will do the same thing an carries nullable
   *     information for the data
   */
  @Override
  @Deprecated
  default  T get(@NotNull DataKey key) {
    return key.get(this);
  }

  @Override
  Object getOrCompute(@NotNull DataKeyBase key, @NotNull DataValueFactory factory);

  /**
   * Store the given value for the key
   *
   * @param  data type of the data referred by the key
   * @param key data key
   * @param value value to store
   * @return mutable data holder for chained calls
   */
  @NotNull
   MutableDataHolder set(@NotNull DataKey key, @NotNull T value);

  /**
   * Store the given value for the key
   *
   * @param  data type of the data referred by the key
   * @param key data key
   * @param value value to store
   * @return mutable data holder for chained calls
   */
  @NotNull
   MutableDataHolder set(@NotNull NullableDataKey key, @Nullable T value);

  /**
   * Remove the stored value for the key, used to force to default or to force recompute
   *
   * @param key data key to remove
   * @return mutable data holder for chained calls
   */
  @NotNull
  MutableDataHolder remove(@NotNull DataKeyBase key);

  /**
   * Store the given value for the key
   *
   * @param dataSetter data setter which will set values
   * @return mutable data holder for chained calls
   */
  @NotNull
  MutableDataHolder setFrom(@NotNull MutableDataSetter dataSetter);

  /**
   * Copy all values from one data holder to this data holder
   *
   * @param other data holder from which to copy all values
   * @return mutable data holder for chained calls
   */
  @NotNull
  MutableDataHolder setAll(@NotNull DataHolder other);

  /**
   * Set options in given mutable data holder
   *
   * @param dataHolder data holder where to copy options from this data holder
   * @return dataHolder
   */
  @NotNull
  @Override
  MutableDataHolder setIn(@NotNull MutableDataHolder dataHolder);

  /**
   * clear all options out of the data set
   *
   * @return mutable data holder for chained calls
   */
  @NotNull
  MutableDataHolder clear();
}