org.sonar.api.server.ws
Class WebService.NewParam

java.lang.Object
  org.sonar.api.server.ws.WebService.NewParam

Enclosing interface:

WebService

public static class WebService.NewParam
extends Object

Method Summary

WebService.NewParam	setBooleanPossibleValues()
WebService.NewParam	setDefaultValue(Object o)
WebService.NewParam	setDescription(String s)
WebService.NewParam	setExampleValue(Object s)
WebService.NewParam	setPossibleValues(Collection values) Exhaustive list of possible values when it makes sense, for example list of severities.
WebService.NewParam	setPossibleValues(Object... values) Exhaustive list of possible values when it makes sense, for example list of severities.
WebService.NewParam	setRequired(boolean b) Is the parameter required or optional ? Default value is false (optional).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

setDescription

public WebService.NewParam setDescription(@Nullable
                                          String s)

setRequired

public WebService.NewParam setRequired(boolean b)

Is the parameter required or optional ? Default value is false (optional).

Since:

4.4

setExampleValue

public WebService.NewParam setExampleValue(@Nullable
                                           Object s)

Since:

4.4

setPossibleValues

public WebService.NewParam setPossibleValues(@Nullable
                                             Object... values)

Exhaustive list of possible values when it makes sense, for example list of severities.

Since:

4.4

setBooleanPossibleValues

public WebService.NewParam setBooleanPossibleValues()

Since:

4.4

setPossibleValues

public WebService.NewParam setPossibleValues(@Nullable
                                             Collection values)

Exhaustive list of possible values when it makes sense, for example list of severities.

Since:

4.4

setDefaultValue

public WebService.NewParam setDefaultValue(@Nullable
                                           Object o)

Since:

4.4

toString

public String toString()

Overrides:

toString in class Object