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() Shortcut for setPossibleValues("true", "false", "yes", "no")
WebService.NewParam	setDefaultValue(Object o)
WebService.NewParam	setDeprecatedKey(String s) Deprecated. since 6.4
WebService.NewParam	setDeprecatedKey(String key, String deprecatedSince)
WebService.NewParam	setDeprecatedSince(String deprecatedSince)
WebService.NewParam	setDescription(String description)
WebService.NewParam	setDescription(String description, Object... descriptionArgument)
WebService.NewParam	setExampleValue(Object s)
WebService.NewParam	setInternal(boolean b) Internal parameters are not displayed by default in the web api documentation.
WebService.NewParam	setMaximumLength(Integer maximumLength)
WebService.NewParam	setMaximumValue(Integer maximumValue)
WebService.NewParam	setMaxValuesAllowed(Integer maxValuesAllowed)
WebService.NewParam	setMinimumLength(Integer minimumLength)
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

See Also:

WebService.Param.since()

setDeprecatedSince

public WebService.NewParam setDeprecatedSince(@Nullable
                                              String deprecatedSince)

Since:

5.3

setDeprecatedKey

@Deprecated
public WebService.NewParam setDeprecatedKey(@Nullable
                                                        String s)

Deprecated. since 6.4

Since:

5.0

See Also:

setDeprecatedKey(String, String)

setDeprecatedKey

public WebService.NewParam setDeprecatedKey(@Nullable
                                            String key,
                                            @Nullable
                                            String deprecatedSince)

Parameters:

deprecatedSince - Version when the old key was replaced/deprecated. Ex: 5.6

Since:

6.4

See Also:

WebService.Param.deprecatedKey()

setDescription

public WebService.NewParam setDescription(@Nullable
                                          String description)

setDescription

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

Since:

5.6

See Also:

WebService.Param.description()

setRequired

public WebService.NewParam setRequired(boolean b)

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

Since:

4.4

See Also:

WebService.Param.isRequired()

setInternal

public WebService.NewParam setInternal(boolean b)

Internal parameters are not displayed by default in the web api documentation. They are displayed only when the check-box "Show Internal API" is selected. By default a parameter is not internal.

Since:

6.2

See Also:

WebService.Param.isInternal()

setExampleValue

public WebService.NewParam setExampleValue(@Nullable
                                           Object s)

Since:

4.4

See Also:

WebService.Param.exampleValue()

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

See Also:

WebService.Param.possibleValues()

setBooleanPossibleValues

public WebService.NewParam setBooleanPossibleValues()

Shortcut for setPossibleValues("true", "false", "yes", "no")

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

See Also:

WebService.Param.possibleValues()

setDefaultValue

public WebService.NewParam setDefaultValue(@Nullable
                                           Object o)

Since:

4.4

See Also:

WebService.Param.defaultValue()

setMaxValuesAllowed

public WebService.NewParam setMaxValuesAllowed(@Nullable
                                               Integer maxValuesAllowed)

Since:

6.4

See Also:

WebService.Param.maxValuesAllowed()

setMaximumLength

public WebService.NewParam setMaximumLength(@Nullable
                                            Integer maximumLength)

Since:

7.0

See Also:

WebService.Param.maximumLength()

setMinimumLength

public WebService.NewParam setMinimumLength(@Nullable
                                            Integer minimumLength)

Since:

7.0

See Also:

WebService.Param.minimumLength()

setMaximumValue

public WebService.NewParam setMaximumValue(@Nullable
                                           Integer maximumValue)

Since:

7.0

See Also:

WebService.Param.maximumValue()

toString

public String toString()

Overrides:

toString in class Object