|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.server.ws.Request
public abstract class Request
Constructor Summary | |
---|---|
Request()
|
Method Summary | ||
---|---|---|
String |
mandatoryParam(String key)
Returns a non-null value. |
|
boolean |
mandatoryParamAsBoolean(String key)
Returns a boolean value. |
|
|
mandatoryParamAsEnum(String key,
Class<E> enumClass)
|
|
int |
mandatoryParamAsInt(String key)
Returns an int value. |
|
long |
mandatoryParamAsLong(String key)
Returns a long value. |
|
List<String> |
mandatoryParamAsStrings(String key)
|
|
abstract String |
method()
Returns the name of the HTTP method with which this request was made. |
|
abstract String |
param(String key)
|
|
String |
param(String key,
String defaultValue)
Deprecated. to be dropped in 4.4. Default values are declared in ws metadata |
|
Boolean |
paramAsBoolean(String key)
|
|
boolean |
paramAsBoolean(String key,
boolean defaultValue)
Deprecated. to be dropped in 4.4. Default values must be declared in WebService then
this method can be replaced by mandatoryParamAsBoolean(String) . |
|
Date |
paramAsDate(String key)
|
|
Date |
paramAsDateTime(String key)
|
|
|
paramAsEnum(String key,
Class<E> enumClass)
|
|
|
paramAsEnums(String key,
Class<E> enumClass)
|
|
Integer |
paramAsInt(String key)
|
|
int |
paramAsInt(String key,
int defaultValue)
Deprecated. to be dropped in 4.4. Default values must be declared in WebService then
this method can be replaced by mandatoryParamAsInt(String) . |
|
Long |
paramAsLong(String key)
|
|
long |
paramAsLong(String key,
long defaultValue)
Deprecated. to be dropped in 4.4. Default values must be declared in WebService then
this method can be replaced by mandatoryParamAsLong(String) . |
|
List<String> |
paramAsStrings(String key)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Request()
Method Detail |
---|
public abstract String method()
public String mandatoryParam(String key)
IllegalArgumentException
- is value is null or blankpublic boolean mandatoryParamAsBoolean(String key)
IllegalArgumentException
- is value is null or blankpublic int mandatoryParamAsInt(String key)
IllegalArgumentException
- is value is null or blankpublic long mandatoryParamAsLong(String key)
IllegalArgumentException
- is value is null or blankpublic <E extends Enum<E>> E mandatoryParamAsEnum(String key, Class<E> enumClass)
public List<String> mandatoryParamAsStrings(String key)
@CheckForNull public List<String> paramAsStrings(String key)
@CheckForNull public abstract String param(String key)
@CheckForNull @Deprecated public String param(String key, @CheckForNull String defaultValue)
@Deprecated public boolean paramAsBoolean(String key, boolean defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsBoolean(String)
.
@Deprecated public int paramAsInt(String key, int defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsInt(String)
.
@Deprecated public long paramAsLong(String key, long defaultValue)
WebService
then
this method can be replaced by mandatoryParamAsLong(String)
.
@CheckForNull public Boolean paramAsBoolean(String key)
@CheckForNull public Integer paramAsInt(String key)
@CheckForNull public Long paramAsLong(String key)
@CheckForNull public <E extends Enum<E>> E paramAsEnum(String key, Class<E> enumClass)
@CheckForNull public <E extends Enum<E>> List<E> paramAsEnums(String key, Class<E> enumClass)
@CheckForNull public Date paramAsDateTime(String key)
@CheckForNull public Date paramAsDate(String key)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |