Class NamedHandleObject

  • All Implemented Interfaces:
    Direct Known Subclasses:
    Category, Command, Context, Scheme

    public abstract class NamedHandleObject
    extends HandleObject
    A handle object that carries with it a name and a description. This type of handle object is quite common across the commands code base. For example, Command, Context and Scheme.
    • Field Detail

      • description

        protected String description
        The description for this handle. This value may be null if the handle is undefined or has no description.
      • name

        protected String name
        The name of this handle. This valud should not be null unless the handle is undefined.
    • Constructor Detail

      • NamedHandleObject

        protected NamedHandleObject​(String id)
        Constructs a new instance of NamedHandleObject.
        id - The identifier for this handle; must not be null.
    • Method Detail

      • getDescription

        public String getDescription()
                              throws NotDefinedException
        Returns the description for this handle.
        The description; may be null if there is no description.
        NotDefinedException - If the handle is not currently defined.