org.sonar.api.rules
Class RulesCategory

java.lang.Object
  org.sonar.api.database.BaseIdentifiable
      org.sonar.api.rules.RulesCategory

public class RulesCategory
extends BaseIdentifiable

A class to hold rules category

Constructor Summary

RulesCategory()
Creates an empty category

RulesCategory(java.lang.String name)
Creates a RuleCategory based on the category name

RulesCategory(java.lang.String name, java.lang.String description)
Creates a category based on the category name and description

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getName()
int	hashCode()
void	setDescription(java.lang.String description) Sets the cay description
void	setName(java.lang.String name) Sets the category name
IsoCategory	toIsoCategory()
java.lang.String	toString()

Methods inherited from class org.sonar.api.database.BaseIdentifiable

getId, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RulesCategory

public RulesCategory(java.lang.String name)

Creates a RuleCategory based on the category name

Parameters:

name - the category name

RulesCategory

public RulesCategory(java.lang.String name,
                     java.lang.String description)

Creates a category based on the category name and description

Parameters:

name - the category name

description - the category description

RulesCategory

public RulesCategory()

Creates an empty category

Method Detail

getName

public java.lang.String getName()

Returns:

the category name

setName

public void setName(java.lang.String name)

Sets the category name

Parameters:

name - the name

getDescription

public java.lang.String getDescription()

Returns:

the category description

setDescription

public void setDescription(java.lang.String description)

Sets the cay description

Parameters:

description - the description

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toIsoCategory

public IsoCategory toIsoCategory()