Class EnumHelpGenerator


  • public class EnumHelpGenerator
    extends AbstractHelpGenerator
    Handler for enums.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    • Constructor Detail

      • EnumHelpGenerator

        public EnumHelpGenerator()
    • Method Detail

      • handles

        public boolean handles​(Class cls)
        Returns whether this class is handled by this generator.
        Specified by:
        handles in class AbstractHelpGenerator
        Parameters:
        cls - the class to check
        Returns:
        true if handled
      • isHtml

        public boolean isHtml​(Class cls)
        Returns whether the generated help is HTML or plain text.
        Specified by:
        isHtml in class AbstractHelpGenerator
        Parameters:
        cls - the class to generate the help for
        Returns:
        true if HTML
      • generate

        public String generate​(Class cls)
        Generates and returns the help for the specified class.
        Specified by:
        generate in class AbstractHelpGenerator
        Parameters:
        cls - the class to generate the help for
        Returns:
        the help, null if failed to produce
      • generate

        public String generate​(Object obj)
        Generates and returns the help for the specified object.
        Specified by:
        generate in class AbstractHelpGenerator
        Parameters:
        obj - the object to generate the help for
        Returns:
        the help, null if failed to produce