pl.chilldev.commons.jsonrpc.rpc.introspector

Annotation Type JsonRpcParam

@Target(value=PARAMETER)
 @Retention(value=RUNTIME)
public @interface JsonRpcParam

Annotation that allows for defining JSON-RPC parameter metadata.

Important note - by default RPC parameters are mandatory, but default value of options() flag in this annotation is true, which means that using this annotation changes default status of the parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	defaultNull Sets default value of the parameter to NULL.
String	defaultValue Sets default value (note that setting `defaultValue` makes `optional` meaningless).
String	name RPC parameter name (if not specified, name from Java method signature will be used).
boolean	optional Marks parameter as optional.

Element Detail

name

public abstract String name

RPC parameter name (if not specified, name from Java method signature will be used).

Returns:

Parameter name.

Default:

""

defaultValue

public abstract String defaultValue

Sets default value (note that setting `defaultValue` makes `optional` meaningless).

Returns:

Default parameter value.

Default:

""

defaultNull

public abstract boolean defaultNull

Sets default value of the parameter to NULL.

Returns:

Default value NULL flag.

Default:

false

optional

public abstract boolean optional

Marks parameter as optional.

Returns:

Optional flag (true by default).

Default:

true