Package 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	Description
static enum	Category.Location

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	defaultOff
private final CategoryId	id
private final Category.Location	location
private final String	name
private final String	tabname

Constructor Summary

Constructors

Constructor	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	Description
@Nullable CategoryId	getId()
Category.Location	getLocation()
String	getName()
@Nullable 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

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

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