water.api

Annotation Type Request.API

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
@Documented
public static @interface Request.API

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	help

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	displayName
double	dmax
double	dmin
java.lang.Class<? extends Request.Filter>	filter
java.lang.Class<? extends Request.Filter>[]	filters
boolean	gridable
boolean	hide
ParamImportance	importance
boolean	json Forces an input field to also appear in JSON.
long	lmax
long	lmin
boolean	mustExist For keys.
boolean	required Must be specified.
int	since
int	until
java.lang.Class<? extends Request.Validator>	validator

Element Detail

help

public abstract java.lang.String help

required

public abstract boolean required

Must be specified.

Default:

false

mustExist

public abstract boolean mustExist

For keys. If specified, the key must exist.

Default:

false

since

public abstract int since

Default:

1

until

public abstract int until

Default:

2147483647

filter

public abstract java.lang.Class<? extends Request.Filter> filter

Default:

water.api.Request.Filter.class

filters

public abstract java.lang.Class<? extends Request.Filter>[] filters

Default:

{}

json

public abstract boolean json

Forces an input field to also appear in JSON.

Default:

false

lmin

public abstract long lmin

Default:

-9223372036854775808L

lmax

public abstract long lmax

Default:

9223372036854775807L

dmin

public abstract double dmin

Default:

-1d/0d

dmax

public abstract double dmax

Default:

1d/0d

hide

public abstract boolean hide

Default:

false

displayName

public abstract java.lang.String displayName

Default:

""

gridable

public abstract boolean gridable

Default:

true

validator

public abstract java.lang.Class<? extends Request.Validator> validator

Default:

water.api.Request.Validator.NOPValidator.class

importance

public abstract ParamImportance importance

Default:

water.api.ParamImportance.UNIMPORTANT