com.kobylynskyi.graphql.codegen.kotlin

Class KotlinGraphQLTypeMapper

java.lang.Object

com.kobylynskyi.graphql.codegen.mapper.GraphQLTypeMapper

com.kobylynskyi.graphql.codegen.kotlin.KotlinGraphQLTypeMapper

public class KotlinGraphQLTypeMapper
extends GraphQLTypeMapper

Mapper class for converting GraphQL types to Kotlin types

Since:

2020/12/09

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	KOTLIN_UTIL_LIST_ELEMENT_REGEX

Constructor Summary

Constructors

Constructor and Description
KotlinGraphQLTypeMapper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	defaultValueKotlinPrimitive(java.lang.String kotlinType) This method is used in kotlin template, do not remove it.
java.lang.String	getResponseReturnType(MappingContext mappingContext, ExtendedFieldDefinition operationDef, NamedDefinition namedDefinition, java.lang.String computedTypeName)
java.lang.String	getTypeConsideringPrimitive(MappingContext mappingContext, NamedDefinition namedDefinition, java.lang.String computedTypeName)
static boolean	isKotlinPrimitive(java.lang.String scalaType)
boolean	isPrimitive(java.lang.String kotlinType) Check if the time is primitive.
java.lang.String	wrapApiDefaultValueIfRequired(MappingContext mappingContext, NamedDefinition namedDefinition, graphql.language.InputValueDefinition inputValueDefinition, java.lang.String defaultValue, java.lang.String parentTypeName) Wraps type into ArgumentValue, if required.
java.lang.String	wrapApiInputTypeIfRequired(MappingContext mappingContext, NamedDefinition namedDefinition, java.lang.String parentTypeName) Wraps type into ArgumentValue, if required.
java.lang.String	wrapApiReturnTypeIfRequired(MappingContext mappingContext, NamedDefinition namedDefinition, java.lang.String parentTypeName) Wraps type into apiReturnType or subscriptionReturnType (defined in the mapping configuration).
java.lang.String	wrapIntoList(MappingContext mappingContext, java.lang.String type, boolean mandatory) Wrap language-specific type (java/scala/kotlin/etc) into List.
java.lang.String	wrapSuperTypeIntoList(MappingContext mappingContext, java.lang.String type, boolean mandatory) Return upper bounded wildcard for the given interface type: "Foo" becomes "List<? extends Foo>".

Methods inherited from class com.kobylynskyi.graphql.codegen.mapper.GraphQLTypeMapper

getDirectives, getGenericsString, getLanguageType, getLanguageType, getLanguageType, getLanguageType, getLanguageType, getLanguageType, getMandatoryType, getNestedTypeName, isInterfaceOrUnion

Methods inherited from class java.lang.Object

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

Field Detail

KOTLIN_UTIL_LIST_ELEMENT_REGEX

public static final java.util.regex.Pattern KOTLIN_UTIL_LIST_ELEMENT_REGEX

Constructor Detail

KotlinGraphQLTypeMapper

public KotlinGraphQLTypeMapper()

Method Detail

isKotlinPrimitive

public static boolean isKotlinPrimitive(java.lang.String scalaType)

defaultValueKotlinPrimitive

public static java.lang.String defaultValueKotlinPrimitive(java.lang.String kotlinType)

This method is used in kotlin template, do not remove it.

Parameters:

kotlinType - type get from Type template

Returns:

default value

wrapIntoList

public java.lang.String wrapIntoList(MappingContext mappingContext,
                                     java.lang.String type,
                                     boolean mandatory)

Description copied from class: GraphQLTypeMapper

Wrap language-specific type (java/scala/kotlin/etc) into List. E.g.: String becomes List<String>

Specified by:

wrapIntoList in class GraphQLTypeMapper

Parameters:

mappingContext - Global mapping context

type - The name of a type that will be wrapped into List<>

mandatory - Type is it mandatory

Returns:

String The name of the given type, wrapped into List<>

wrapSuperTypeIntoList

public java.lang.String wrapSuperTypeIntoList(MappingContext mappingContext,
                                              java.lang.String type,
                                              boolean mandatory)

Description copied from class: GraphQLTypeMapper

Return upper bounded wildcard for the given interface type: "Foo" becomes "List<? extends Foo>".

Specified by:

wrapSuperTypeIntoList in class GraphQLTypeMapper

Parameters:

mappingContext - Global mapping context

type - The name of a type whose upper bound wildcard will be wrapped into a list.

mandatory - Type is it mandatory

Returns:

String The name of the the wrapped type.

wrapApiReturnTypeIfRequired

public java.lang.String wrapApiReturnTypeIfRequired(MappingContext mappingContext,
                                                    NamedDefinition namedDefinition,
                                                    java.lang.String parentTypeName)

Description copied from class: GraphQLTypeMapper

Wraps type into apiReturnType or subscriptionReturnType (defined in the mapping configuration).

Example 1: * Given GraphQL schema: type Query { events: [Event!]! } * Given config: useOptionalForNullableReturnTypes = true * Return: java.util.Optional<Event>

Example 2: * Given GraphQL schema: type Subscription { eventsCreated: [Event!]! } * Given subscriptionReturnType in config: org.reactivestreams.Publisher * Return: org.reactivestreams.Publisher<Event>

Example 3: * Given GraphQL schema: type Mutation { createEvent(inp: Inp): Event } * Given apiReturnType in config: reactor.core.publisher.Mono * Return: reactor.core.publisher.Mono<Event>

Example 4: * Given GraphQL schema: type Query { events: [Event!]! } * Given apiReturnListType in config: reactor.core.publisher.Flux * Return: reactor.core.publisher.Flux<Event>

Specified by:

wrapApiReturnTypeIfRequired in class GraphQLTypeMapper

Parameters:

mappingContext - Global mapping context

namedDefinition - Named definition

parentTypeName - Name of the parent type

Returns:

Java/Scala type wrapped into the subscriptionReturnType

isPrimitive

public boolean isPrimitive(java.lang.String kotlinType)

Description copied from class: GraphQLTypeMapper

Check if the time is primitive.

Specified by:

isPrimitive in class GraphQLTypeMapper

Parameters:

kotlinType - type to check

Returns:

true if the provided type is primitive, false if the provided type is not primitive

getTypeConsideringPrimitive

public java.lang.String getTypeConsideringPrimitive(MappingContext mappingContext,
                                                    NamedDefinition namedDefinition,
                                                    java.lang.String computedTypeName)

Overrides:

getTypeConsideringPrimitive in class GraphQLTypeMapper

getResponseReturnType

public java.lang.String getResponseReturnType(MappingContext mappingContext,
                                              ExtendedFieldDefinition operationDef,
                                              NamedDefinition namedDefinition,
                                              java.lang.String computedTypeName)

Overrides:

getResponseReturnType in class GraphQLTypeMapper

wrapApiInputTypeIfRequired

public java.lang.String wrapApiInputTypeIfRequired(MappingContext mappingContext,
                                                   NamedDefinition namedDefinition,
                                                   java.lang.String parentTypeName)

Description copied from class: GraphQLTypeMapper

Wraps type into ArgumentValue, if required.

Example 1: * Given GraphQL schema: input MyInput { name: String! } * Given config: useWrapperForNullableInputTypes = true * Return: String

Example 2: * Given GraphQL schema: input MyInput { name: String } * Given config: useWrapperForNullableInputTypes = true * Return: ArgumentValue<String>

Example 2: * Given GraphQL schema: input MyInput { name: String[] } * Given config: useWrapperForNullableInputTypes = true * Return: List<String>

Specified by:

wrapApiInputTypeIfRequired in class GraphQLTypeMapper

Parameters:

mappingContext - Global mapping context

namedDefinition - Named definition

parentTypeName - Name of the parent type

Returns:

Java type wrapped into ArgumentValue

wrapApiDefaultValueIfRequired

public java.lang.String wrapApiDefaultValueIfRequired(MappingContext mappingContext,
                                                      NamedDefinition namedDefinition,
                                                      graphql.language.InputValueDefinition inputValueDefinition,
                                                      java.lang.String defaultValue,
                                                      java.lang.String parentTypeName)

Description copied from class: GraphQLTypeMapper

Wraps type into ArgumentValue, if required.

Example 1: * Given GraphQL schema: input MyInput { name: String } * Given config: useWrapperForNullableInputTypes = true * Return: ArgumentValue.omitted()

Example 2: * Given GraphQL schema: input MyInput { name: String = null } * Given config: useWrapperForNullableInputTypes = true * Return: ArgumentValue.ofNullable(null)

Example 2: * Given GraphQL schema: input MyInput { name: String = "some value" } * Given config: useWrapperForNullableInputTypes = true * Return: ArgumentValue.ofNullable("some value")

Specified by:

wrapApiDefaultValueIfRequired in class GraphQLTypeMapper

Parameters:

mappingContext - Global mapping context

namedDefinition - Named definition

inputValueDefinition - Input value definition

defaultValue - Default value

parentTypeName - Name of the parent type

Returns:

Java type wrapped into ArgumentValue