Package cloud.commandframework.bungee.arguments

Class ServerArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo>
cloud.commandframework.bungee.arguments.ServerArgument<C>
Type Parameters:
C - Command sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<net.md_5.bungee.api.config.ServerInfo>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class ServerArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo>
Argument parser for servers
Since:
1.1.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ServerArgument.Builder<C>
     
    static final class 
    ServerArgument.ServerParseException
     
    static final class 
    ServerArgument.ServerParser<C>
     

    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 ServerArgument.Builder<C>
    builder(@NonNull String name)
    Create a new ServerArgument.Builder.
    static <C> @NonNull ServerArgument.Builder<C>
    newBuilder(@NonNull String name)
    Deprecated.
    prefer builder(String)
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo>
    of(@NonNull String name)
    Create a new required server argument
    static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo>
    optional(@NonNull String name)
    Create a new optional server argument

    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

      @API(status=STABLE, since="1.8.0") public static <C> @NonNull ServerArgument.Builder<C> builder(@NonNull String name)
      Create a new ServerArgument.Builder.
      Type Parameters:
      C - sender type
      Parameters:
      name - argument name
      Returns:
      new ServerArgument.Builder
      Since:
      1.8.0

    • newBuilder

      @API(status=DEPRECATED, since="1.8.0") @Deprecated public static <C> @NonNull ServerArgument.Builder<C> newBuilder(@NonNull String name)
      Deprecated.
      prefer builder(String)
      Create a new builder
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the argument
      Returns:
      Created builder

    • of

      public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo> of(@NonNull String name)
      Create a new required server argument
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      Returns:
      Created argument

    • optional

      public static <C> @NonNull cloud.commandframework.arguments.CommandArgument<C,net.md_5.bungee.api.config.ServerInfo> optional(@NonNull String name)
      Create a new optional server argument
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      Returns:
      Created argument