Interface Command.Descriptor

  • Enclosing interface:
    Command

    public static interface Command.Descriptor
    An interface that can be used to describe the the functionality of the command implementation. This is a very important concept in a text-driven environment such as a command-line user interface.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      This method should return a descriptive text about the command it is attached to.
      java.lang.String getName()
      Implementation of this method should return a simple string (with no spaces) that identifies the action mapped to this command.
      java.lang.String getNamespace()
      The purpose of the namespace is to provide an identifier to group commands without relying on class name or other convoluted approaches to group commands.
    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        The purpose of the namespace is to provide an identifier to group commands without relying on class name or other convoluted approaches to group commands.
        Returns:
        the command's namespace
      • getName

        java.lang.String getName()
        Implementation of this method should return a simple string (with no spaces) that identifies the action mapped to this command.
        Returns:
        the name of the action mapped to this command.
      • getDescription

        java.lang.String getDescription()
        This method should return a descriptive text about the command it is attached to.
        Returns:
        a descriptive text about the command