net.inveed.jsonrpc.core.annotation

Annotation Type JsonRpcParam

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

Because Java doesn't retain information about method names in a class file and therefore this information is not available in runtime, this annotation MUST be placed on all the method parameters. Otherwise IllegalArgumentException will be generated in runtime and an error message will be returned to a client.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value RPC method parameter name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	required Whether parameter is required If false, it means that a client isn't forced to pass this parameter to the method.

Element Detail

value

public abstract String value

RPC method parameter name. MUST be specified.

Returns:

parameter name

required

public abstract boolean required

Whether parameter is required If false, it means that a client isn't forced to pass this parameter to the method. If the client doesn't provide the parameter, null value is used for complex types and an appropriate default value for primitives.

Returns:

whether parameter is required

Default:

true