Package net.kyori.adventure.pointer

Interface Pointers

All Superinterfaces:
Buildable<Pointers,Pointers.Builder>
public interface Pointers extends Buildable<Pointers,Pointers.Builder>
A collection of pointers.
Since:
4.8.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Pointers.Builder
    A builder of pointers.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Pointers.Builder
    builder()
    Gets a new pointers builder.
    static @NotNull Pointers
    empty()
    Gets an empty pointers collection.
    <T> @NotNull Optional<T>
    get(@NotNull Pointer<T> pointer)
    Gets the value of pointer.
    default <T> T
    getOrDefault(@NotNull Pointer<T> pointer, T defaultValue)
    Gets the value of pointer.
    default <T> @UnknownNullability T
    getOrDefaultFrom(@NotNull Pointer<T> pointer, @NotNull Supplier<? extends T> defaultValue)
    Gets the value of pointer.
    <T> boolean
    supports(@NotNull Pointer<T> pointer)
    Checks if a given pointer is supported.

    Methods inherited from interface net.kyori.adventure.util.Buildable

    toBuilder

  • Method Details

    • empty

      @Contract(pure=true) @NotNull static @NotNull Pointers empty()
      Gets an empty pointers collection.
      Returns:
      the pointers
      Since:
      4.8.0

    • builder

      @Contract(pure=true) @NotNull static @NotNull Pointers.Builder builder()
      Gets a new pointers builder.
      Returns:
      the builder
      Since:
      4.8.0
      See Also:

    • get

      @NotNull <T> @NotNull Optional<T> get(@NotNull @NotNull Pointer<T> pointer)
      Gets the value of pointer.
      Type Parameters:
      T - the type
      Parameters:
      pointer - the pointer
      Returns:
      the value
      Since:
      4.8.0

    • getOrDefault

      @Contract("_, null -> _; _, !null -> !null") @Nullable default <T> T getOrDefault(@NotNull @NotNull Pointer<T> pointer, @Nullable T defaultValue)
      Gets the value of pointer.

      If a value for pointer is unable to be provided, defaultValue will be returned.

      Type Parameters:
      T - the type
      Parameters:
      pointer - the pointer
      defaultValue - the default value
      Returns:
      the value
      Since:
      4.8.0

    • getOrDefaultFrom

      default <T> @UnknownNullability T getOrDefaultFrom(@NotNull @NotNull Pointer<T> pointer, @NotNull @NotNull Supplier<? extends T> defaultValue)
      Gets the value of pointer.

      If a value for pointer is unable to be provided, the value supplied by defaultValue will be returned.

      Type Parameters:
      T - the type
      Parameters:
      pointer - the pointer
      defaultValue - the default value supplier
      Returns:
      the value
      Since:
      4.8.0

    • supports

      <T> boolean supports(@NotNull @NotNull Pointer<T> pointer)
      Checks if a given pointer is supported.

      This will return true when a mapping for the provided pointer exists, even if the value for the pointer is null.

      Type Parameters:
      T - the type
      Parameters:
      pointer - the pointer
      Returns:
      if the pointer is supported
      Since:
      4.8.0