Package com.tenio.core.bootstrap.annotation

Annotation Interface SystemCommand

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface SystemCommand
A class annotated by this annotation will allow modifying the server's behavior.
Since:
0.4.0
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Retrieves the command's description.
    boolean
    isBackgroundRunning
    Whether the command will be run in background.
    String
    label
    Retrieves the label of command, that should be unique, otherwise, an exception will be thrown.
    String[]
    usage
    Retrieves a list of usage for the command.

  • Element Details

    • label

      String label
      Retrieves the label of command, that should be unique, otherwise, an exception will be thrown.
      Returns:
      the String label of command
      See Also:
      Default:
      ""

    • usage

      String[] usage
      Retrieves a list of usage for the command.
      Returns:
      a list of String instructions that the command is supporting
      Default:
      {""}

    • description

      String description
      Retrieves the command's description.
      Returns:
      the String command's description
      Default:
      ""

    • isBackgroundRunning

      boolean isBackgroundRunning
      Whether the command will be run in background.
      Returns:
      true when the command will be run in a separated thread, otherwise, returns false
      Default:
      false