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

Modifier and Type	Method and Description
WebService.NewParam	setBooleanPossibleValues()
WebService.NewParam	setDefaultValue(Object o)
WebService.NewParam	setDeprecatedKey(String s)
WebService.NewParam	setDeprecatedSince(String deprecatedSince)
WebService.NewParam	setDescription(String description)
WebService.NewParam	setDescription(String description, Object... descriptionArgument)
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).
WebService.NewParam	setSince(String since)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

setSince

public WebService.NewParam setSince(@Nullable
                                    String since)

Since:

5.3

setDeprecatedSince

public WebService.NewParam setDeprecatedSince(@Nullable
                                              String deprecatedSince)

Since:

5.3

setDeprecatedKey

public WebService.NewParam setDeprecatedKey(@Nullable
                                            String s)

Since:

5.0

setDescription

public WebService.NewParam setDescription(@Nullable
                                          String description)

setDescription

public WebService.NewParam setDescription(@Nullable
                                          String description,
                                          Object... descriptionArgument)

Since:

5.6

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