com.adobe.cq.social.commons.annotation

Annotation Type Parameter

@Target(value={TYPE,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface Parameter

This annotation is used to specify a request parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description A descriptive text to provide the client information about this parameter.
java.lang.String	name The name of the parameter.
boolean	required Specified if the parameter is required or not.
java.lang.String	value The value of the parameter.

Element Detail

name

public abstract java.lang.String name

The name of the parameter.

Returns:

String

Default:

""

value

public abstract java.lang.String value

The value of the parameter.

Returns:

String

Default:

""

required

public abstract boolean required

Specified if the parameter is required or not.

Returns:

boolean

Default:

false

description

public abstract java.lang.String description

A descriptive text to provide the client information about this parameter.

Returns:

String

Default:

""