Package no.sikt.graphitron.definitions.objects

Class EnumDefinition

java.lang.Object

no.sikt.graphitron.definitions.objects.AbstractObjectDefinition<graphql.language.EnumTypeDefinition,EnumField>

no.sikt.graphitron.definitions.objects.EnumDefinition

All Implemented Interfaces:

GenerationTarget, ObjectSpecification<EnumField>

public class EnumDefinition
extends AbstractObjectDefinition<graphql.language.EnumTypeDefinition,EnumField>
implements GenerationTarget

Representation of a GraphQL enum type.

Constructor Summary

Constructors

Constructor	Description
EnumDefinition(graphql.language.EnumTypeDefinition enumTypeDefinition)

Method Summary

Modifier and Type	Method	Description
protected List<EnumField>	createFields(graphql.language.EnumTypeDefinition objectDefinition)
CodeReference	getEnumReference()
boolean	hasJavaEnumMapping()
boolean	isDirectionEnum()
boolean	isOrderByEnum()
static List<EnumDefinition>	processEnumDefinitions(List<graphql.language.EnumTypeDefinition> enums)	Creates instances of this class for each of the EnumTypeDefinition provided.

Methods inherited from class no.sikt.graphitron.definitions.objects.AbstractObjectDefinition

equals, getClassReference, getFieldByName, getFields, getGraphClassName, getName, getObjectDefinition, hasField, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface no.sikt.graphitron.definitions.interfaces.GenerationTarget

createsDataFetcher, createsDataFetchersForFields, isExplicitlyNotGenerated, isGenerated, isGeneratedWithResolver

Methods inherited from interface no.sikt.graphitron.definitions.interfaces.ObjectSpecification

isOperationRoot

Constructor Details

EnumDefinition

public EnumDefinition(graphql.language.EnumTypeDefinition enumTypeDefinition)

Method Details

createFields

protected List<EnumField> createFields(graphql.language.EnumTypeDefinition objectDefinition)

Specified by:

createFields in class AbstractObjectDefinition<graphql.language.EnumTypeDefinition,EnumField>

getEnumReference

public CodeReference getEnumReference()

Returns:

Reference to the external Java enum that should correspond to the one in the schema.

hasJavaEnumMapping

public boolean hasJavaEnumMapping()

Returns:

Does this enum map to another enum in the API?

processEnumDefinitions

public static List<EnumDefinition> processEnumDefinitions(List<graphql.language.EnumTypeDefinition> enums)

Creates instances of this class for each of the EnumTypeDefinition provided.

Returns:

List of EnumDefinitions.

isOrderByEnum

public boolean isOrderByEnum()

Returns:

Does this enum have values with @order or @index directives (i.e., it defines sort fields)?

isDirectionEnum

public boolean isDirectionEnum()

Returns:

Is this a direction enum (exactly two values: ASC and DESC)?