Class Category

java.lang.Object
org.languagetool.rules.Category

public final class Category extends Object
A rule's category. Categories are used to group rules for a better overview.
  • Field Details

    • name

      private final String name
    • id

      private final CategoryId id
    • location

      private final Category.Location location
    • defaultOff

      private final boolean defaultOff
    • tabname

      private final String tabname
  • Constructor Details

  • Method Details

    • getId

      @Nullable public @Nullable CategoryId getId()
      Since:
      3.3
    • getName

      public String getName()
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getTabName

      @Nullable public @Nullable String getTabName()
      Since:
      4.3
    • isDefaultOff

      public boolean isDefaultOff()
      Checks whether the category has been turned off by default by the category author.
      Returns:
      True if the category is turned off by default.
    • getLocation

      public Category.Location getLocation()
      Since:
      2.8