Package cloud.commandframework.fabric.argument.server

Class MessageArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,Message>
cloud.commandframework.fabric.argument.server.MessageArgument<C>
Type Parameters:
C - the sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<Message>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class MessageArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,Message>
An argument similar to a greedy string, but one that resolves selectors.
Since:
1.5.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MessageArgument.Builder<C>
    Builder for MessageArgument.

    Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

    cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    static <C> @NonNull MessageArgument.Builder<C>
    builder(@NonNull String name)
    Create a new MessageArgument.Builder.
    static <C> @NonNull MessageArgument<C>
    of(@NonNull String name)
    Create a new required MessageArgument.
    static <C> @NonNull MessageArgument<C>
    optional(@NonNull String name)
    Create a new optional MessageArgument.
    static <C> @NonNull MessageArgument<C>
    optional(@NonNull String name, @NonNull String defaultValue)
    Create a new optional MessageArgument with the specified value.

    Methods inherited from class cloud.commandframework.arguments.CommandArgument

    addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      public static <C> @NonNull MessageArgument.Builder<C> builder(@NonNull String name)
      Create a new MessageArgument.Builder.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the argument
      Returns:
      Created builder
      Since:
      1.5.0

    • of

      public static <C> @NonNull MessageArgument<C> of(@NonNull String name)
      Create a new required MessageArgument.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      Returns:
      Created argument
      Since:
      1.5.0

    • optional

      public static <C> @NonNull MessageArgument<C> optional(@NonNull String name)
      Create a new optional MessageArgument.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      Returns:
      Created argument
      Since:
      1.5.0

    • optional

      public static <C> @NonNull MessageArgument<C> optional(@NonNull String name, @NonNull String defaultValue)
      Create a new optional MessageArgument with the specified value.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      defaultValue - Default value
      Returns:
      Created argument
      Since:
      1.5.0