Class Spec


  • public class Spec
    extends java.lang.Object
    Describes a command (excluding the command name).
    • Constructor Summary

      Constructors 
      Constructor Description
      Spec​(byte id, Parameter... parameters)
      Creates a new instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte getId()
      Returns the token id used to highlight this command.
      Parameter getParameter​(java.lang.String name)
      Returns the parameter specification for a parameter name.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Spec

        public Spec​(byte id,
                    Parameter... parameters)
        Creates a new instance.
        Parameters:
        id - the token id used to highlight this command
        parameters - the possible parameters of this command
    • Method Detail

      • getId

        public byte getId()
        Returns the token id used to highlight this command.
        Returns:
        the token id
      • getParameter

        public Parameter getParameter​(java.lang.String name)
        Returns the parameter specification for a parameter name.
        Parameters:
        name - the parameter name
        Returns:
        the parameter specification, or null if the parameter name is invalid for this command