java.com.graphql_java_generator.annotation.GraphQLInputParameters Maven / Gradle / Ivy
/**
*
*/
package com.graphql_java_generator.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 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
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface GraphQLInputParameters {
/**
* 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
* {@link #types()}. The nth name this list, must be linked to the nth type in the {@link #types()}
* list.
*
* @return
*/
public String[] names();
/**
* 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
* {@link #names()}. The nth type this list, must be linked to the nth name in the {@link #names()}
* list.
*
* @return
*/
public String[] types();
/**
* Contains for each input parameters named in {@link #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 {@link #names()}. The nth type this list, must be
* linked to the nth name in the {@link #names()} list.
*
* @return
*/
public boolean[] mandatories() default {};
/**
* Contains for each input parameters named in {@link #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
* {@link #names()}. The nth type this list, must be linked to the nth name in the {@link #names()}
* list.
*
* @return
*/
public int[] listDepths() default {};
/**
* Contains for each input parameters named in {@link #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
* {@link #names()}. The nth type this list, must be linked to the nth name in the {@link #names()}
* list.
*
* @return
*/
public boolean[] itemsMandatory() default {};
}