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.

Author:

Daniel Naber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Category.Location

Constructor Summary

Constructors

Constructor and Description
Category(String name) Create a new category.
Category(String name, Category.Location location) Create a new category.
Category(String name, Category.Location location, boolean onByDefault) Create a new category.
Category(String name, int priority, Category.Location location, boolean onByDefault) Deprecated. priority will be removed, as it had not been used (deprecated since 2.8)

Method Summary

Methods

Modifier and Type	Method and Description
Category.Location	getLocation()
String	getName()
int	getPriority()
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(String name,
        int priority,
        Category.Location location,
        boolean onByDefault)

Deprecated. priority will be removed, as it had not been used (deprecated since 2.8)

Create a new category with the given name and priority.

Parameters:

name - name of the category

priority - a value between 0 and 100 (inclusive)

Category

public Category(String name)

Create a new category.

Parameters:

name - name of the category

Category

public Category(String name,
        Category.Location location)

Create a new category.

Parameters:

name - name of the category

Since:

2.8

Category

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

Create a new category.

Parameters:

name - name of the category

Since:

2.9

Method Detail

getName

public String getName()

getPriority

public int getPriority()

toString

public String toString()

Overrides:

toString in class Object

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