Enum AvailableSyntaxHighlighters

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AvailableSyntaxHighlighters>

    public enum AvailableSyntaxHighlighters
    extends java.lang.Enum<AvailableSyntaxHighlighters>
    Lists the available syntax highlighter engines by language.
    Since:
    6.0.0
    Author:
    Clément Fournier
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Optional<SyntaxHighlighter> getHighlighterForLanguage​(net.sourceforge.pmd.lang.Language language)
      Gets the highlighter for a language if available.
      static AvailableSyntaxHighlighters valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AvailableSyntaxHighlighters[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static AvailableSyntaxHighlighters[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AvailableSyntaxHighlighters c : AvailableSyntaxHighlighters.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AvailableSyntaxHighlighters valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getHighlighterForLanguage

        public static java.util.Optional<SyntaxHighlighter> getHighlighterForLanguage​(net.sourceforge.pmd.lang.Language language)
        Gets the highlighter for a language if available.
        Parameters:
        language - Language to look for
        Returns:
        A highlighter, if available