Package com.graphql_java_generator.annotation

Annotation Type GraphQLInputParameters

@Retention(RUNTIME)
@Target({FIELD,METHOD})
public @interface GraphQLInputParameters

This class indicates that this field has at least one input parameter. It can be associated with field (for concrete classes) or setter methods (for interfaces).

Author:

etienne-sf

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String[]	names	Contains the list of the names for each of the input parameters of this field.
String[]	types	Contains the list of the types for each of the input parameters of this field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean[]	itemsMandatory	Contains for each input parameters named in names(), true if this parameter is a list and its items are mandatory (according to GraphQL list's specification), and false otherwise.
int[]	listDepths	Contains for each input parameters named in names(), 0 if this parameter is not a list, and a positive number if this input parameter is a list (2, for instance for [[Int]]).
boolean[]	mandatories	Contains for each input parameters named in names(), true if this parameter is mandatory, and false otherwise.

Element Details

names

String[] names

Contains the list of the names for each of the input parameters of this field. It must contain at least one item (as this annotation indicates that this field has input parameter(s), and must have the same number of items as types(). The nth name this list, must be linked to the nth type in the types() list.

Returns:

types

String[] types

Contains the list of the types for each of the input parameters of this field. It must contain at least one item (as this annotation indicates that this field has input parameter(s), and must have the same number of items as names(). The nth type this list, must be linked to the nth name in the names() list.

Returns:

mandatories

boolean[] mandatories

Contains for each input parameters named in names(), true if this parameter is mandatory, and false otherwise. It must contain at least one item (as this annotation indicates that this field has input parameter(s), and must have the same number of items as names(). The nth type this list, must be linked to the nth name in the names() list.

Returns:

Default:

{}

listDepths

int[] listDepths

Contains for each input parameters named in names(), 0 if this parameter is not a list, and a positive number if this input parameter is a list (2, for instance for [[Int]]). It must contain at least one item (as this annotation indicates that this field has input parameter(s), and must have the same number of items as names(). The nth type this list, must be linked to the nth name in the names() list.

Returns:

Default:

{}

itemsMandatory

boolean[] itemsMandatory

Contains for each input parameters named in names(), true if this parameter is a list and its items are mandatory (according to GraphQL list's specification), and false otherwise. It must contain at least one item (as this annotation indicates that this field has input parameter(s), and must have the same number of items as names(). The nth type this list, must be linked to the nth name in the names() list.

Returns:

Default:

{}