Enum RuleMatch.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RuleMatch.Type>
    Enclosing class:
    RuleMatch

    @Experimental
    public static enum RuleMatch.Type
    extends java.lang.Enum<RuleMatch.Type>
    Unlike Category, this is specific to a RuleMatch, not to a rule. It is mainly used for selecting the underline color in clients. Note: this is experimental and might change soon (types might be added, deleted or renamed without deprecating them first)
    Since:
    4.3
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Hint
      Style errors, typically light blue.
      Other
      Other errors (including grammar), typically yellow/orange.
      UnknownWord
      Spelling errors, typically red.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Type()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static RuleMatch.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RuleMatch.Type[] 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
    • Enum Constant Detail

      • UnknownWord

        public static final RuleMatch.Type UnknownWord
        Spelling errors, typically red.
      • Hint

        public static final RuleMatch.Type Hint
        Style errors, typically light blue.
      • Other

        public static final RuleMatch.Type Other
        Other errors (including grammar), typically yellow/orange.
    • Constructor Detail

      • Type

        private Type()
    • Method Detail

      • values

        public static RuleMatch.Type[] 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 (RuleMatch.Type c : RuleMatch.Type.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RuleMatch.Type 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