Enum RuleMatch.Type

java.lang.Object
java.lang.Enum<RuleMatch.Type>
org.languagetool.rules.RuleMatch.Type
All Implemented Interfaces:
Serializable, Comparable<RuleMatch.Type>, java.lang.constant.Constable
Enclosing class:
RuleMatch

@Experimental public static enum RuleMatch.Type extends 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 Details

    • 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 Details

    • Type

      private Type()
  • Method Details

    • values

      public static RuleMatch.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static RuleMatch.Type valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null