Package 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 java.lang.Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description WebService.NewParam
setBooleanPossibleValues()
Shortcut forsetPossibleValues("true", "false", "yes", "no")
WebService.NewParam
setDefaultValue(java.lang.Object o)
WebService.NewParam
setDeprecatedKey(java.lang.String s)
Deprecated.since 6.4WebService.NewParam
setDeprecatedKey(java.lang.String key, java.lang.String deprecatedSince)
WebService.NewParam
setDeprecatedSince(java.lang.String deprecatedSince)
WebService.NewParam
setDescription(java.lang.String description)
WebService.NewParam
setDescription(java.lang.String description, java.lang.Object... descriptionArgument)
WebService.NewParam
setExampleValue(java.lang.Object s)
WebService.NewParam
setInternal(boolean b)
Internal parameters are not displayed by default in the web api documentation.WebService.NewParam
setMaximumLength(java.lang.Integer maximumLength)
WebService.NewParam
setMaximumValue(java.lang.Integer maximumValue)
WebService.NewParam
setMaxValuesAllowed(java.lang.Integer maxValuesAllowed)
WebService.NewParam
setMinimumLength(java.lang.Integer minimumLength)
<T> WebService.NewParam
setPossibleValues(java.util.Collection<T> values)
Exhaustive list of possible values when it makes sense, for example list of severities.<T> WebService.NewParam
setPossibleValues(T... 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(java.lang.String since)
java.lang.String
toString()
-
-
-
Method Detail
-
setSince
public WebService.NewParam setSince(@Nullable java.lang.String since)
- Since:
- 5.3
- See Also:
WebService.Param.since()
-
setDeprecatedSince
public WebService.NewParam setDeprecatedSince(@Nullable java.lang.String deprecatedSince)
- Since:
- 5.3
-
setDeprecatedKey
@Deprecated public WebService.NewParam setDeprecatedKey(@Nullable java.lang.String s)
Deprecated.since 6.4- Since:
- 5.0
- See Also:
setDeprecatedKey(String, String)
-
setDeprecatedKey
public WebService.NewParam setDeprecatedKey(@Nullable java.lang.String key, @Nullable java.lang.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 java.lang.String description)
-
setDescription
public WebService.NewParam setDescription(@Nullable java.lang.String description, java.lang.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 java.lang.Object s)
- Since:
- 4.4
- See Also:
WebService.Param.exampleValue()
-
setPossibleValues
public <T> WebService.NewParam setPossibleValues(@Nullable T... 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 forsetPossibleValues("true", "false", "yes", "no")
- Since:
- 4.4
-
setPossibleValues
public <T> WebService.NewParam setPossibleValues(@Nullable java.util.Collection<T> 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 java.lang.Object o)
- Since:
- 4.4
- See Also:
WebService.Param.defaultValue()
-
setMaxValuesAllowed
public WebService.NewParam setMaxValuesAllowed(@Nullable java.lang.Integer maxValuesAllowed)
- Since:
- 6.4
- See Also:
WebService.Param.maxValuesAllowed()
-
setMaximumLength
public WebService.NewParam setMaximumLength(@Nullable java.lang.Integer maximumLength)
- Since:
- 7.0
- See Also:
WebService.Param.maximumLength()
-
setMinimumLength
public WebService.NewParam setMinimumLength(@Nullable java.lang.Integer minimumLength)
- Since:
- 7.0
- See Also:
WebService.Param.minimumLength()
-
setMaximumValue
public WebService.NewParam setMaximumValue(@Nullable java.lang.Integer maximumValue)
- Since:
- 7.0
- See Also:
WebService.Param.maximumValue()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-