org.languagetool.rules

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Category.Location

Constructor Summary

Constructors

Constructor and Description
Category(CategoryId id, String name)
Category(CategoryId id, String name, Category.Location location)
Category(CategoryId id, String name, Category.Location location, boolean onByDefault)
Category(CategoryId id, String name, Category.Location location, boolean onByDefault, String tabName)

Method Summary

Modifier and Type	Method and Description
CategoryId	getId()
Category.Location	getLocation()
String	getName()
String	getTabName()
boolean	isDefaultOff() Checks whether the category has been turned off by default by the category author.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Category

public Category(CategoryId id,
                String name)

Since:

3.3

Category

public Category(CategoryId id,
                String name,
                Category.Location location)

Since:

3.3

Category

public Category(CategoryId id,
                String name,
                Category.Location location,
                boolean onByDefault)

Since:

3.3

Category

public Category(CategoryId id,
                String name,
                Category.Location location,
                boolean onByDefault,
                String tabName)

Since:

4.3

Method Detail

getId

@NotNull
public CategoryId getId()

Since:

3.3

getName

@NotNull
public String getName()

toString

public String toString()

Overrides:

toString in class Object

getTabName

@Nullable
public 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