org.sonar.api.checks.templates
Class CheckTemplate

java.lang.Object
  org.sonar.api.checks.templates.CheckTemplate

Direct Known Subclasses:

BundleCheckTemplate, DefaultCheckTemplate

public abstract class CheckTemplate
extends java.lang.Object

EXPERIMENTAL - will be used in version 2.2

Since:

2.1

Field Summary

protected java.lang.String	configKey
protected IsoCategory	isoCategory
protected java.lang.String	key
protected Priority	priority
protected java.util.List<CheckTemplateProperty>	properties

Constructor Summary

CheckTemplate()

CheckTemplate(java.lang.String key)

Method Summary

void	addProperty(CheckTemplateProperty p)
boolean	equals(java.lang.Object o) Checks are equal within the same plugin.
java.lang.String	getConfigKey()
abstract java.lang.String	getDescription(java.util.Locale locale)
IsoCategory	getIsoCategory()
java.lang.String	getKey()
abstract java.lang.String	getMessage(java.util.Locale locale, java.lang.String key, java.lang.Object... params)
Priority	getPriority()
java.util.List<CheckTemplateProperty>	getProperties()
CheckTemplateProperty	getProperty(java.lang.String key)
abstract java.lang.String	getTitle(java.util.Locale locale)
int	hashCode()
void	setConfigKey(java.lang.String configKey)
void	setIsoCategory(IsoCategory c)
void	setKey(java.lang.String s)
void	setPriority(Priority p)

Methods inherited from class java.lang.Object

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

Field Detail

key

protected java.lang.String key

configKey

protected java.lang.String configKey

priority

protected Priority priority

isoCategory

protected IsoCategory isoCategory

properties

protected java.util.List<CheckTemplateProperty> properties

Constructor Detail

CheckTemplate

public CheckTemplate(java.lang.String key)

CheckTemplate

public CheckTemplate()

Method Detail

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String s)

getPriority

public Priority getPriority()

setPriority

public void setPriority(Priority p)

getIsoCategory

public IsoCategory getIsoCategory()

setIsoCategory

public void setIsoCategory(IsoCategory c)

getConfigKey

public java.lang.String getConfigKey()

setConfigKey

public void setConfigKey(java.lang.String configKey)

getTitle

public abstract java.lang.String getTitle(java.util.Locale locale)

getDescription

public abstract java.lang.String getDescription(java.util.Locale locale)

getMessage

public abstract java.lang.String getMessage(java.util.Locale locale,
                                            java.lang.String key,
                                            java.lang.Object... params)

getProperties

public java.util.List<CheckTemplateProperty> getProperties()

addProperty

public void addProperty(CheckTemplateProperty p)

getProperty

public CheckTemplateProperty getProperty(java.lang.String key)

equals

public final boolean equals(java.lang.Object o)

Checks are equal within the same plugin. Two plugins can have two different checks with the same key.

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object