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 Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASCENDING
static String	FACETS
static String	FIELDS
static String	PAGE
static String	PAGE_SIZE
static String	SELECTED
static String	SORT
static String	TEXT_QUERY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebService.Param(WebService.Action action, WebService.NewParam newParam)

Method Summary

Methods

Modifier and Type	Method and Description
String	defaultValue()
String	deprecatedKey()
String	deprecatedSince()
String	description()
String	exampleValue()
boolean	isRequired() Is the parameter required or optional ?
String	key()
Set<String>	possibleValues()
String	since()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_QUERY

public static final String TEXT_QUERY

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

PAGE_SIZE

public static final String PAGE_SIZE

See Also:

Constant Field Values

FIELDS

public static final String FIELDS

See Also:

Constant Field Values

SORT

public static final String SORT

See Also:

Constant Field Values

ASCENDING

public static final String ASCENDING

See Also:

Constant Field Values

FACETS

public static final String FACETS

See Also:

Constant Field Values

SELECTED

public static final String SELECTED

See Also:

Constant Field Values

Constructor Detail

WebService.Param

protected WebService.Param(WebService.Action action,
                WebService.NewParam newParam)

Method Detail

key

public String key()

since

@CheckForNull
public String since()

Since:

5.3

deprecatedSince

@CheckForNull
public String deprecatedSince()

Since:

5.3

deprecatedKey

@CheckForNull
public String deprecatedKey()

Since:

5.0

description

@CheckForNull
public String description()

exampleValue

@CheckForNull
public String exampleValue()

Since:

4.4

isRequired

public boolean isRequired()

Is the parameter required or optional ?

Since:

4.4

possibleValues

@CheckForNull
public Set<String> possibleValues()

Since:

4.4

defaultValue

@CheckForNull
public String defaultValue()

Since:

4.4

toString

public String toString()

Overrides:

toString in class Object