Package org.languagetool.rules

Class Category

java.lang.Object

org.languagetool.rules.Category

public final class Category
extends java.lang.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 class	Category.Location

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Category(CategoryId id, java.lang.String name)
Category(CategoryId id, java.lang.String name, Category.Location location)
Category(CategoryId id, java.lang.String name, Category.Location location, boolean onByDefault)
Category(CategoryId id, java.lang.String name, Category.Location location, boolean onByDefault, java.lang.String tabname)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

id

private final CategoryId id

location

private final Category.Location location

defaultOff

private final boolean defaultOff

tabname

private final java.lang.String tabname

Constructor Detail

Category

public Category(CategoryId id,
                java.lang.String name)

Since:

3.3

Category

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

Since:

3.3

Category

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

Since:

3.3

Category

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

Since:

4.3

Method Detail

getId

@Nullable
public @Nullable CategoryId getId()

Since:

3.3

getName

public java.lang.String getName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTabName

@Nullable
public @Nullable java.lang.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