Package org.sonar.api.server.rule

Class RulesDefinition.NewParam

java.lang.Object

org.sonar.api.server.rule.RulesDefinition.NewParam

Direct Known Subclasses:

DefaultNewParam

Enclosing interface:

RulesDefinition

public abstract static class RulesDefinition.NewParam
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
NewParam()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.String	key()
abstract RulesDefinition.NewParam	setDefaultValue(java.lang.String s)	Empty default value will be converted to null.
abstract RulesDefinition.NewParam	setDescription(java.lang.String s)	Plain-text description.
abstract RulesDefinition.NewParam	setName(java.lang.String s)
abstract RulesDefinition.NewParam	setType(RuleParamType t)

Methods inherited from class java.lang.Object

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

Constructor Detail

NewParam

public NewParam()

Method Detail

key

public abstract java.lang.String key()

setName

public abstract RulesDefinition.NewParam setName(@Nullable
                                                 java.lang.String s)

setType

public abstract RulesDefinition.NewParam setType(RuleParamType t)

setDescription

public abstract RulesDefinition.NewParam setDescription(@Nullable
                                                        java.lang.String s)

Plain-text description. Can be null. Max length is 4000 characters.

setDefaultValue

public abstract RulesDefinition.NewParam setDefaultValue(@Nullable
                                                         java.lang.String s)

Empty default value will be converted to null. Max length is 4000 characters.