Package cloud.commandframework.arguments.parser

Class ParserParameters

java.lang.Object
cloud.commandframework.arguments.parser.ParserParameters
@API(status=STABLE) public final class ParserParameters extends Object
Collection of parameter-object pairs

  • Constructor Details

    • ParserParameters

      public ParserParameters()

  • Method Details

    • empty

      public static @NonNull ParserParameters empty()
      Get an empty ParserParameters instance
      Returns:
      Empty instance

    • single

      public static <T> @NonNull ParserParameters single(@NonNull ParserParameter<T> parameter, @NonNull T value)
      Create a ParserParameters instance containing a single key-value par
      Type Parameters:
      T - Value type
      Parameters:
      parameter - Parameter
      value - Value
      Returns:
      Constructed instance

    • has

      public <T> boolean has(@NonNull ParserParameter<T> parameter)
      Check if this instance contains a parameter-object pair for a given parameter
      Type Parameters:
      T - Parameter type
      Parameters:
      parameter - Parameter
      Returns:
      true if such a pair is stored, else false

    • store

      public <T> void store(@NonNull ParserParameter<T> parameter, @NonNull T value)
      Store a parameter-object pair
      Type Parameters:
      T - Parameter type
      Parameters:
      parameter - Parameter
      value - Object

    • get

      public <T> @NonNull T get(@NonNull ParserParameter<T> parameter, @NonNull T defaultValue)
      Get a value from the parameter map, if it is stored, else return a default value
      Type Parameters:
      T - Parameter type
      Parameters:
      parameter - Parameter to retrieve
      defaultValue - Default value
      Returns:
      Parameter value

    • merge

      public void merge(@NonNull ParserParameters other)
      Attempt to merge two ParserParameters instances. If the instances contain conflicting values, the values of the "other" instance will be preferred
      Parameters:
      other - Other instance

    • getAll

      public @NonNull Map<@NonNull ParserParameter<?>,@NonNull Object> getAll()
      Get an immutable view of the internal map
      Returns:
      Immutable map