Interface IAnnotatedObjectDescriptor

    • Method Detail

      • getIcon

        java.net.URL getIcon()
        Get the Icon representing the annotated object, for example provided by the annotation Icon.
        Returns:
        the Icon as a URL
      • getIdentifier

        java.lang.String getIdentifier()
        Get the identifier for the annotated object, for example provided by the annotation CommandName or getName().
        Returns:
        the identifier
      • getName

        java.lang.String getName()
        Get the name, for example provided by the annotation Name.
        Returns:
        the name
      • getHelp

        java.lang.String getHelp()
        Get the help String, for example provided by the annotation Help.
        Returns:
        the help
      • getHelpUrl

        java.lang.String getHelpUrl()
        Get the help URL, for example provided by the annotation HelpUrl.
        Returns:
        the help URL
      • getHelpLocale

        java.util.Locale getHelpLocale()
        Get the help locale
        Returns:
        the locale
      • getArguments

        java.util.List<ArgumentDescriptor> getArguments()
        Get descriptors for the fields annotated by the annotation Argument. TODO Should this have been IArgumentDescriptor ?
        Returns:
        the list of annotated arguments, see ArgumentDescriptor
      • isHelpAvailable

        boolean isHelpAvailable()
        Check if the object has provided some help via annotations.
        Returns:
        true if the object or arguments were annotated with Help.