Package org.mycore.frontend.cli.annotation

Annotation Interface MCRCommand

@Retention(RUNTIME) @Documented @Target(METHOD) public @interface MCRCommand
Annotates a public static method as a command that could be executed via MCRCommandLineInterface.
Author:
Thomas Scheffler (yagee)

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    syntax
    The syntax of the command in MessageFormat syntax

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    help
    Help text that should be returned by help command.
    String
    helpKey
    I18N key for the help text that should be returned by help command.
    int
    order
    If syntax() conflicts, use order to specify in which order the invocation should be tried.

  • Element Details

    • help

      String help
      Help text that should be returned by help command.
      Default:
      ""

    • helpKey

      String helpKey
      I18N key for the help text that should be returned by help command.
      Default:
      ""

    • order

      int order
      If syntax() conflicts, use order to specify in which order the invocation should be tried.
      Default:
      1