Interface Registry<T>

Type Parameters:
T - the type of the values
All Known Subinterfaces:
WritableRegistry<T>
public interface Registry<T>
The values of a registry, addressed by TypedKey, in network order.

Every registry holds the vanilla entries; writable ones may also hold entries added or replaced by plugins.

Since:
0.1.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(TypedKey<T> key)
    Returns whether something is registered under key.
    Optional<T>
    find(TypedKey<T> key)
    Returns the value registered under a key, or empty if there is none.
    T
    get(TypedKey<T> key)
    Gets the value registered under a key.
    boolean
    isCustom(TypedKey<T> key)
    Returns whether key was added or replaced by a plugin rather than coming from vanilla.
    boolean
    isTagged(TypedKey<T> key, TagKey<T> tag)
    Returns whether key belongs to tag.
    TypedKey<T>
    key(T value)
    Gets the key a value is registered under.
    Collection<TypedKey<T>>
    keys()
    Returns every registered key, in network order.
    RegistryKey<T>
    registryKey()
    Returns the key identifying this registry.
    int
    size()
    Returns the number of registered values.
    Stream<T>
    stream()
    Returns a stream over every registered value, in network order.
    Collection<TypedKey<T>>
    tag(TagKey<T> tag)
    Returns the members of tag, in order, or an empty collection if the tag does not exist.
    Collection<TagKey<T>>
    tags()
    Returns every tag of this registry.
    Collection<T>
    values()
    Returns every registered value, in network order.

  • Method Details

    • registryKey

      RegistryKey<T> registryKey()
      Returns the key identifying this registry.
      Returns:
      the key identifying this registry
      Since:
      0.1.0

    • get

      T get(TypedKey<T> key)
      Gets the value registered under a key.
      Parameters:
      key - the key
      Returns:
      the value
      Throws:
      NoSuchElementException - if nothing is registered under that key
      Since:
      0.1.0

    • find

      Optional<T> find(TypedKey<T> key)
      Returns the value registered under a key, or empty if there is none.
      Parameters:
      key - the key
      Returns:
      the value registered under a key, or empty if there is none
      Since:
      0.1.0

    • key

      TypedKey<T> key(T value)
      Gets the key a value is registered under.
      Parameters:
      value - the value
      Returns:
      its key
      Throws:
      IllegalArgumentException - if the value is not registered
      Since:
      0.1.0

    • contains

      boolean contains(TypedKey<T> key)
      Returns whether something is registered under key.
      Parameters:
      key - the key
      Returns:
      whether something is registered under key
      Since:
      0.1.0

    • isCustom

      boolean isCustom(TypedKey<T> key)
      Returns whether key was added or replaced by a plugin rather than coming from vanilla.
      Parameters:
      key - the key
      Returns:
      whether key was added or replaced by a plugin rather than coming from vanilla
      Since:
      0.1.0

    • keys

      Collection<TypedKey<T>> keys()
      Returns every registered key, in network order.
      Returns:
      every registered key, in network order
      Since:
      0.1.0

    • values

      Collection<T> values()
      Returns every registered value, in network order.
      Returns:
      every registered value, in network order
      Since:
      0.1.0

    • stream

      Stream<T> stream()
      Returns a stream over every registered value, in network order.
      Returns:
      a stream over every registered value, in network order
      Since:
      0.1.0

    • size

      int size()
      Returns the number of registered values.
      Returns:
      the number of registered values
      Since:
      0.1.0

    • tags

      Collection<TagKey<T>> tags()
      Returns every tag of this registry.
      Returns:
      every tag of this registry
      Since:
      0.1.0

    • tag

      Collection<TypedKey<T>> tag(TagKey<T> tag)
      Returns the members of tag, in order, or an empty collection if the tag does not exist.
      Parameters:
      tag - the tag
      Returns:
      the members of tag, in order, or an empty collection if the tag does not exist
      Since:
      0.1.0

    • isTagged

      boolean isTagged(TypedKey<T> key, TagKey<T> tag)
      Returns whether key belongs to tag.
      Parameters:
      key - the key
      tag - the tag
      Returns:
      whether key belongs to tag
      Since:
      0.1.0