Module org.spongepowered.plugin.spi
Package org.spongepowered.plugin.blackboard

Interface Blackboard

All Known Implementing Classes:
StandardBlackboard
public interface Blackboard
An entity that stores various properties for an environment

  • Method Summary

    Modifier and Type
    Method
    Description
    <V> Optional<V>
    find(Key<V> key)
     
    <V> V
    get(Key<V> key)
     
    <V> void
    set(Key<V> key, V value)
    Sets a value by key.

  • Method Details

    • set

      <V> void set(Key<V> key, V value)
      Sets a value by key.
      Type Parameters:
      V - The value type
      Parameters:
      key - The key
      value - The value
      Throws:
      IllegalStateException - if the key already has a corresponding value

    • get

      <V> V get(Key<V> key)
      Type Parameters:
      V - The value type
      Parameters:
      key - The key
      Returns:
      The value
      Throws:
      IllegalArgumentException - if the key has no corresponding value

    • find

      <V> Optional<V> find(Key<V> key)
      Type Parameters:
      V - The value type
      Parameters:
      key - The key
      Returns:
      The value or Optional.empty() otherwise