org.languagetool.rules
Class Category

Object
  Category

public class Category
extends Object

A rule's category. Categories are used to group rules for a better overview.

Author:

Daniel Naber

Constructor Summary

Category(String name)
Create a new category with the default priority (50).

Category(String name, int priority)
Create a new category with the given name and priority.

Method Summary

String	getName()
int	getPriority()
boolean	isDefaultOff() Checks whether the category has been turned off by default by the category author.
void	setDefaultOff() Turns the category by default off.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Category

public Category(String name,
                int priority)

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 with the default priority (50).

Parameters:

name - name of the category

Method Detail

getName

public String getName()

getPriority

public int getPriority()

toString

public String toString()

Overrides:

toString in class Object

isDefaultOff

public final 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.

setDefaultOff

public final void setDefaultOff()

Turns the category by default off.