io.smallrye.graphql.schema

Class Annotations

java.lang.Object

io.smallrye.graphql.schema.Annotations

public class Annotations
extends Object

All the annotations we care about for a certain context There are multiple static methods to create the annotations for the correct context

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.jandex.DotName	BEAN_VALIDATION_NOT_BLANK
static org.jboss.jandex.DotName	BEAN_VALIDATION_NOT_EMPTY
static org.jboss.jandex.DotName	BEAN_VALIDATION_NOT_NULL
static org.jboss.jandex.DotName	DATE_FORMAT
static org.jboss.jandex.DotName	DEFAULT_VALUE
static org.jboss.jandex.DotName	DESCRIPTION
static org.jboss.jandex.DotName	ENUM
static org.jboss.jandex.DotName	ERROR_CODE
static org.jboss.jandex.DotName	GRAPHQL_API
static org.jboss.jandex.DotName	ID
static org.jboss.jandex.DotName	IGNORE
static org.jboss.jandex.DotName	INPUT
static org.jboss.jandex.DotName	INTERFACE
static org.jboss.jandex.DotName	JSONB_DATE_FORMAT
static org.jboss.jandex.DotName	JSONB_NUMBER_FORMAT
static org.jboss.jandex.DotName	JSONB_PROPERTY
static org.jboss.jandex.DotName	JSONB_TRANSIENT
static org.jboss.jandex.DotName	MUTATION
static org.jboss.jandex.DotName	NAME
static org.jboss.jandex.DotName	NON_NULL
static org.jboss.jandex.DotName	NUMBER_FORMAT
static org.jboss.jandex.DotName	QUERY
static org.jboss.jandex.DotName	SOURCE
static org.jboss.jandex.DotName	TO_SCALAR
static org.jboss.jandex.DotName	TYPE

Method Summary

Modifier and Type	Method and Description
boolean	containsKeyAndValidValue(org.jboss.jandex.DotName annotation) Check if there is an annotation and it has a valid value
boolean	containsOneOfTheseAnnotations(org.jboss.jandex.DotName... annotations) Check if one of these annotations is present
Set<org.jboss.jandex.DotName>	getAnnotationNames()
static Annotations	getAnnotationsForArgument(org.jboss.jandex.MethodInfo methodInfo, short pos) Used when we are creating operation and arguments for these operations
static Annotations	getAnnotationsForArray(org.jboss.jandex.Type typeInCollection, org.jboss.jandex.Type methodTypeInCollection) Get used when creating arrays.
static Annotations	getAnnotationsForClass(org.jboss.jandex.ClassInfo classInfo) Get used when we create types and references to them Class level annotation for type creation.
static Annotations	getAnnotationsForInterfaceField(org.jboss.jandex.MethodInfo methodInfo) Get used when creating fields on interfaces.
static Annotations	getAnnotationsForMethod(org.jboss.jandex.MethodInfo methodInfo) Get used when creating operations.
static Annotations	getAnnotationsForPojo(Direction direction, org.jboss.jandex.FieldInfo fieldInfo) Get used when creating fields on inputs and types.
static Annotations	getAnnotationsForPojo(Direction direction, org.jboss.jandex.FieldInfo fieldInfo, org.jboss.jandex.MethodInfo methodInfo) Get used when creating fields on inputs and types.
org.jboss.jandex.AnnotationValue	getAnnotationValue(org.jboss.jandex.DotName annotation) Get a specific annotation
Optional<org.jboss.jandex.AnnotationInstance>	getOneOfTheseAnnotations(org.jboss.jandex.DotName... annotations) Get on of these annotations
Optional<String>	getOneOfTheseAnnotationsValue(org.jboss.jandex.DotName... annotations) This go through a list of annotations and find the first one that has a valid value.
Optional<String>	getOneOfTheseMethodAnnotationsValue(org.jboss.jandex.DotName... annotations) This go through a list of method annotations and find the first one that has a valid value.
Optional<String>	getOneOfTheseMethodParameterAnnotationsValue(org.jboss.jandex.DotName... annotations) This go through a list of method parameter annotations and find the first one that has a valid value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TO_SCALAR

public static final org.jboss.jandex.DotName TO_SCALAR

ERROR_CODE

public static final org.jboss.jandex.DotName ERROR_CODE

GRAPHQL_API

public static final org.jboss.jandex.DotName GRAPHQL_API

QUERY

public static final org.jboss.jandex.DotName QUERY

MUTATION

public static final org.jboss.jandex.DotName MUTATION

INPUT

public static final org.jboss.jandex.DotName INPUT

TYPE

public static final org.jboss.jandex.DotName TYPE

INTERFACE

public static final org.jboss.jandex.DotName INTERFACE

ENUM

public static final org.jboss.jandex.DotName ENUM

ID

public static final org.jboss.jandex.DotName ID

DESCRIPTION

public static final org.jboss.jandex.DotName DESCRIPTION

DATE_FORMAT

public static final org.jboss.jandex.DotName DATE_FORMAT

NUMBER_FORMAT

public static final org.jboss.jandex.DotName NUMBER_FORMAT

DEFAULT_VALUE

public static final org.jboss.jandex.DotName DEFAULT_VALUE

IGNORE

public static final org.jboss.jandex.DotName IGNORE

NON_NULL

public static final org.jboss.jandex.DotName NON_NULL

NAME

public static final org.jboss.jandex.DotName NAME

SOURCE

public static final org.jboss.jandex.DotName SOURCE

JSONB_DATE_FORMAT

public static final org.jboss.jandex.DotName JSONB_DATE_FORMAT

JSONB_NUMBER_FORMAT

public static final org.jboss.jandex.DotName JSONB_NUMBER_FORMAT

JSONB_PROPERTY

public static final org.jboss.jandex.DotName JSONB_PROPERTY

JSONB_TRANSIENT

public static final org.jboss.jandex.DotName JSONB_TRANSIENT

BEAN_VALIDATION_NOT_NULL

public static final org.jboss.jandex.DotName BEAN_VALIDATION_NOT_NULL

BEAN_VALIDATION_NOT_EMPTY

public static final org.jboss.jandex.DotName BEAN_VALIDATION_NOT_EMPTY

BEAN_VALIDATION_NOT_BLANK

public static final org.jboss.jandex.DotName BEAN_VALIDATION_NOT_BLANK

Method Detail

getAnnotationsForMethod

public static Annotations getAnnotationsForMethod(org.jboss.jandex.MethodInfo methodInfo)

Get used when creating operations. Operation only have methods (no properties)

Parameters:

methodInfo - the java method

Returns:

Annotations for this method and its return-type

getAnnotationsForInterfaceField

public static Annotations getAnnotationsForInterfaceField(org.jboss.jandex.MethodInfo methodInfo)

Get used when creating fields on interfaces. Interfaces only has methods, no properties

Parameters:

methodInfo - the java method

Returns:

Annotations for this method

getAnnotationsForPojo

public static Annotations getAnnotationsForPojo(Direction direction,
                                                org.jboss.jandex.FieldInfo fieldInfo)

Get used when creating fields on inputs and types. This is used for public fields

Parameters:

direction - the direction

fieldInfo - the java property

Returns:

annotations for this field

getAnnotationsForPojo

public static Annotations getAnnotationsForPojo(Direction direction,
                                                org.jboss.jandex.FieldInfo fieldInfo,
                                                org.jboss.jandex.MethodInfo methodInfo)

Get used when creating fields on inputs and types. Both has properties and methods and this needs to combined the two

Parameters:

direction - the direction

fieldInfo - the java property

methodInfo - the java method

Returns:

annotations for this field

getAnnotationsForClass

public static Annotations getAnnotationsForClass(org.jboss.jandex.ClassInfo classInfo)

Get used when we create types and references to them Class level annotation for type creation.

Parameters:

classInfo - the java class

Returns:

annotation for this class

getAnnotationsForArray

public static Annotations getAnnotationsForArray(org.jboss.jandex.Type typeInCollection,
                                                 org.jboss.jandex.Type methodTypeInCollection)

Get used when creating arrays. This will contains the annotation on the collection field and method

Parameters:

typeInCollection - the field java type

methodTypeInCollection - the method java type

Returns:

the annotation for this array

getAnnotationsForArgument

public static Annotations getAnnotationsForArgument(org.jboss.jandex.MethodInfo methodInfo,
                                                    short pos)

Used when we are creating operation and arguments for these operations

Parameters:

methodInfo - the java method

pos - the argument position

Returns:

annotation for this argument

getAnnotationNames

public Set<org.jboss.jandex.DotName> getAnnotationNames()

getAnnotationValue

public org.jboss.jandex.AnnotationValue getAnnotationValue(org.jboss.jandex.DotName annotation)

Get a specific annotation

Parameters:

annotation - the annotation you want

Returns:

the annotation value or null

containsKeyAndValidValue

public boolean containsKeyAndValidValue(org.jboss.jandex.DotName annotation)

Check if there is an annotation and it has a valid value

Parameters:

annotation - the annotation we are checking

Returns:

true if valid value

containsOneOfTheseAnnotations

public boolean containsOneOfTheseAnnotations(org.jboss.jandex.DotName... annotations)

Check if one of these annotations is present

Parameters:

annotations - the annotations to check

Returns:

true if it does

getOneOfTheseAnnotations

public Optional<org.jboss.jandex.AnnotationInstance> getOneOfTheseAnnotations(org.jboss.jandex.DotName... annotations)

Get on of these annotations

Parameters:

annotations - the annotations to check (in order)

Returns:

the annotation potentially or empty if not found

getOneOfTheseAnnotationsValue

public Optional<String> getOneOfTheseAnnotationsValue(org.jboss.jandex.DotName... annotations)

This go through a list of annotations and find the first one that has a valid value. If it could not find one, it return empty

Parameters:

annotations - the annotations in order

Returns:

the valid annotation value or default value

getOneOfTheseMethodAnnotationsValue

public Optional<String> getOneOfTheseMethodAnnotationsValue(org.jboss.jandex.DotName... annotations)

This go through a list of method annotations and find the first one that has a valid value. If it could not find one, it return the default value.

Parameters:

annotations - the annotations in order

Returns:

the valid annotation value or empty

getOneOfTheseMethodParameterAnnotationsValue

public Optional<String> getOneOfTheseMethodParameterAnnotationsValue(org.jboss.jandex.DotName... annotations)

This go through a list of method parameter annotations and find the first one that has a valid value. If it could not find one, it return the default value.

Parameters:

annotations - the annotations in order

Returns:

the valid annotation value or empty

toString

public String toString()

Overrides:

toString in class Object