Package cloud.commandframework.arguments.flags

Class CommandFlag<T>

  • Type Parameters:
    T - Command argument type. Void is used when no argument is present.
    public final class CommandFlag<T>
extends java.lang.Object
    A flag is an optional command argument that may have an associated parser, and is identified by its name. Essentially, it's a mixture of a command literal and an optional variable command argument.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CommandFlag.Builder<T>  

    • Method Summary

      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      @NonNull java.util.Collection<@NonNull java.lang.String> getAliases()
      Get all flag aliases.
      @Nullable CommandArgument<?,​T> getCommandArgument()
      Get the command argument, if it exists
      @NonNull Description getDescription()
      Get the flag description
      @NonNull java.lang.String getName()
      Get the flag name
      int hashCode()  
      static @NonNull CommandFlag.Builder<java.lang.Void> newBuilder​(@NonNull java.lang.String name)
      Create a new flag builder
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • newBuilder

        public static @NonNull CommandFlag.Builder<java.lang.Void> newBuilder​(@NonNull java.lang.String name)
        Create a new flag builder
        Parameters:
        name - Flag name
        Returns:
        Flag builder

      • getName

        public @NonNull java.lang.String getName()
        Get the flag name
        Returns:
        Flag name

      • getAliases

        public @NonNull java.util.Collection<@NonNull java.lang.String> getAliases()
        Get all flag aliases. This does not include the flag name
        Returns:
        Flag aliases

      • getDescription

        public @NonNull Description getDescription()
        Get the flag description

        Returns:
        Flag description

      • getCommandArgument

        public @Nullable CommandArgument<?,​T> getCommandArgument()
        Get the command argument, if it exists
        Returns:
        Command argument, or null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object