Package org.sonar.api.server.ws
Class WebService.Param
- java.lang.Object
-
- org.sonar.api.server.ws.WebService.Param
-
- Enclosing interface:
- WebService
@Immutable public static class WebService.Param extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ASCENDING
static java.lang.String
FACETS
static java.lang.String
FIELDS
static java.lang.String
PAGE
static java.lang.String
PAGE_SIZE
static java.lang.String
SELECTED
static java.lang.String
SORT
static java.lang.String
TEXT_QUERY
-
Constructor Summary
Constructors Modifier Constructor Description protected
Param(WebService.Action action, WebService.NewParam newParam)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
defaultValue()
java.lang.String
deprecatedKey()
java.lang.String
deprecatedKeySince()
java.lang.String
deprecatedSince()
java.lang.String
description()
java.lang.String
exampleValue()
boolean
isInternal()
Is the parameter internal ?boolean
isRequired()
Is the parameter required or optional ?java.lang.String
key()
java.lang.Integer
maximumLength()
Specify the maximum length of the value used in this parameterjava.lang.Integer
maximumValue()
Specify the maximum value of the numeric variable used in this parameterjava.lang.Integer
maxValuesAllowed()
Specify the maximum number of values allowed when usingRequest.multiParam(String)
java.lang.Integer
minimumLength()
Specify the minimum length of the value used in this parameterjava.util.Set<java.lang.String>
possibleValues()
java.lang.String
since()
java.lang.String
toString()
-
-
-
Field Detail
-
TEXT_QUERY
public static final java.lang.String TEXT_QUERY
- See Also:
- Constant Field Values
-
PAGE
public static final java.lang.String PAGE
- See Also:
- Constant Field Values
-
PAGE_SIZE
public static final java.lang.String PAGE_SIZE
- See Also:
- Constant Field Values
-
FIELDS
public static final java.lang.String FIELDS
- See Also:
- Constant Field Values
-
SORT
public static final java.lang.String SORT
- See Also:
- Constant Field Values
-
ASCENDING
public static final java.lang.String ASCENDING
- See Also:
- Constant Field Values
-
FACETS
public static final java.lang.String FACETS
- See Also:
- Constant Field Values
-
SELECTED
public static final java.lang.String SELECTED
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Param
protected Param(WebService.Action action, WebService.NewParam newParam)
-
-
Method Detail
-
key
public java.lang.String key()
-
since
@CheckForNull public java.lang.String since()
- Since:
- 5.3
-
deprecatedSince
@CheckForNull public java.lang.String deprecatedSince()
- Since:
- 5.3
-
deprecatedKey
@CheckForNull public java.lang.String deprecatedKey()
- Since:
- 5.0
-
deprecatedKeySince
@CheckForNull public java.lang.String deprecatedKeySince()
- Since:
- 6.4
-
description
@CheckForNull public java.lang.String description()
-
exampleValue
@CheckForNull public java.lang.String exampleValue()
- Since:
- 4.4
-
isRequired
public boolean isRequired()
Is the parameter required or optional ?- Since:
- 4.4
-
isInternal
public boolean isInternal()
Is the parameter internal ?- Since:
- 6.2
- See Also:
WebService.NewParam.setInternal(boolean)
-
possibleValues
@CheckForNull public java.util.Set<java.lang.String> possibleValues()
- Since:
- 4.4
-
defaultValue
@CheckForNull public java.lang.String defaultValue()
- Since:
- 4.4
-
maxValuesAllowed
public java.lang.Integer maxValuesAllowed()
Specify the maximum number of values allowed when usingRequest.multiParam(String)
- Since:
- 6.4
-
maximumLength
@CheckForNull public java.lang.Integer maximumLength()
Specify the maximum length of the value used in this parameter- Since:
- 7.0
-
minimumLength
@CheckForNull public java.lang.Integer minimumLength()
Specify the minimum length of the value used in this parameter- Since:
- 7.0
-
maximumValue
@CheckForNull public java.lang.Integer maximumValue()
Specify the maximum value of the numeric variable used in this parameter- Since:
- 7.0
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-