me.moros.bending.api.util.data.DataHolder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bending-api Show documentation
Modern Bending api for Minecraft
The newest version!
/*
 * Copyright 2020-2024 Moros
 *
 * This file is part of Bending.
 *
 * Bending is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Bending is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Bending. If not, see .
 */

package me.moros.bending.api.util.data;

import java.util.Optional;
import java.util.OptionalDouble;
import java.util.OptionalInt;
import java.util.OptionalLong;

/**
 * Represents a holder of data key-value pairs.
 */
public interface DataHolder {
  /**
   * Attempt to retrieve the data for the specified key.
   * @param key the key associated with data
   * @param  the type of data
   * @return the data that was retrieved if available
   */
   Optional get(DataKey key);

  default OptionalInt getInt(DataKey key) {
    return this.get(key).map(OptionalInt::of).orElseGet(OptionalInt::empty);
  }

  default OptionalDouble getDouble(DataKey key) {
    return this.get(key).map(OptionalDouble::of).orElseGet(OptionalDouble::empty);
  }

  default OptionalLong getLong(DataKey key) {
    return this.get(key).map(OptionalLong::of).orElseGet(OptionalLong::empty);
  }

  /**
   * Check whether this holder has the specified data key.
   * @param key the key associated with data
   * @param  the type of data
   * @return whether the key if available
   */
  default  boolean has(DataKey key) {
    return get(key).isPresent();
  }

  /**
   * Store data for a specified key.
   * @param key the key used to store and access the data
   * @param value the data to store
   * @param  the type of data
   */
   void add(DataKey key, T value);

  /**
   * Attempt to remove the data for the specified key.
   * @param key the key associated with data
   * @param  the type of data
   */
   void remove(DataKey key);
}