Add some javadocs, rearrange EnumDefinitionToDataModelMapper

Author: kobylynskyi

src/main/java/com/kobylynskyi/graphql/codegen/mapper/EnumDefinitionToDataModelMapper.java

@@ -2,9 +2,13 @@
 
 import com.kobylynskyi.graphql.codegen.model.MappingConfig;
 import graphql.language.EnumTypeDefinition;
+import graphql.language.EnumValueDefinition;
 
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import static com.kobylynskyi.graphql.codegen.model.DataModelFields.*;
 
@@ -28,8 +32,24 @@ public static Map<String, Object> map(MappingConfig mappingConfig, EnumTypeDefin
         dataModel.put(PACKAGE, packageName);
         dataModel.put(IMPORTS, MapperUtils.getImports(mappingConfig, packageName));
         dataModel.put(CLASS_NAME, MapperUtils.getClassNameWithPrefixAndSuffix(mappingConfig, enumDef));
-        dataModel.put(FIELDS, EnumValueDefinitionToStringMapper.map(enumDef.getEnumValueDefinitions()));
+        dataModel.put(FIELDS, map(enumDef.getEnumValueDefinitions()));
         return dataModel;
     }
 
+    /**
+     * Mapper from GraphQL's EnumValueDefinition to a Freemarker-understandable format
+     *
+     * @param enumValueDefinitions list of GraphQL EnumValueDefinition types
+     * @return list of strings
+     */
+    private static List<String> map(List<EnumValueDefinition> enumValueDefinitions) {
+        if (enumValueDefinitions == null) {
+            return Collections.emptyList();
+        }
+        return enumValueDefinitions.stream()
+                .map(EnumValueDefinition::getName)
+                .map(MapperUtils::capitalizeIfRestricted)
+                .collect(Collectors.toList());
+    }
+
 }

src/main/java/com/kobylynskyi/graphql/codegen/mapper/EnumValueDefinitionToStringMapper.java

@@ -15,6 +15,14 @@
  */
 class GraphqlTypeToJavaTypeMapper {
 
+    /**
+     * Map GraphQL's FieldDefinition to a Freemarker-understandable format of operation
+     *
+     * @param mappingConfig  Global mapping configuration
+     * @param fieldDef       GraphQL field definition
+     * @param parentTypeName Name of the parent type
+     * @return Freemarker-understandable format of parameter (field)
+     */
     public static ParameterDefinition map(MappingConfig mappingConfig, FieldDefinition fieldDef, String parentTypeName) {
         ParameterDefinition parameter = new ParameterDefinition();
         parameter.setName(MapperUtils.capitalizeIfRestricted(fieldDef.getName()));
@@ -23,6 +31,14 @@ public static ParameterDefinition map(MappingConfig mappingConfig, FieldDefiniti
         return parameter;
     }
 
+    /**
+     * Map GraphQL's InputValueDefinition to a Freemarker-understandable format of operation
+     *
+     * @param mappingConfig        Global mapping configuration
+     * @param inputValueDefinition GraphQL input value definition
+     * @param parentTypeName       Name of the parent type
+     * @return Freemarker-understandable format of parameter (field)
+     */
     public static ParameterDefinition map(MappingConfig mappingConfig, InputValueDefinition inputValueDefinition, String parentTypeName) {
         ParameterDefinition parameter = new ParameterDefinition();
         parameter.setName(MapperUtils.capitalizeIfRestricted(inputValueDefinition.getName()));
@@ -31,22 +47,47 @@ public static ParameterDefinition map(MappingConfig mappingConfig, InputValueDef
         return parameter;
     }
 
+    /**
+     * Convert GraphQL type to a corresponding Java type
+     *
+     * @param mappingConfig Global mapping configuration
+     * @param type          GraphQL type
+     * @return Corresponding Java type
+     */
     static String getJavaType(MappingConfig mappingConfig, Type type) {
         return getJavaType(mappingConfig, type, null, null);
     }
 
-    static String getJavaType(MappingConfig mappingConfig, Type type, String name, String parentTypeName) {
-        if (type instanceof TypeName) {
-            return getJavaType(mappingConfig, ((TypeName) type).getName(), name, parentTypeName);
-        } else if (type instanceof ListType) {
-            String mappedCollectionType = getJavaType(mappingConfig, ((ListType) type).getType(), name, parentTypeName);
+    /**
+     * Convert GraphQL type to a corresponding Java type
+     *
+     * @param mappingConfig  Global mapping configuration
+     * @param graphlType     GraphQL type
+     * @param name           GraphQL type name
+     * @param parentTypeName Name of the parent type
+     * @return Corresponding Java type
+     */
+    static String getJavaType(MappingConfig mappingConfig, Type graphlType, String name, String parentTypeName) {
+        if (graphlType instanceof TypeName) {
+            return getJavaType(mappingConfig, ((TypeName) graphlType).getName(), name, parentTypeName);
+        } else if (graphlType instanceof ListType) {
+            String mappedCollectionType = getJavaType(mappingConfig, ((ListType) graphlType).getType(), name, parentTypeName);
             return wrapIntoJavaCollection(mappedCollectionType);
-        } else if (type instanceof NonNullType) {
-            return getJavaType(mappingConfig, ((NonNullType) type).getType(), name, parentTypeName);
+        } else if (graphlType instanceof NonNullType) {
+            return getJavaType(mappingConfig, ((NonNullType) graphlType).getType(), name, parentTypeName);
         }
         return null;
     }
 
+    /**
+     * Convert GraphQL type to a corresponding Java type
+     *
+     * @param mappingConfig  Global mapping configuration
+     * @param graphlType     GraphQL type
+     * @param name           GraphQL type name
+     * @param parentTypeName Name of the parent type
+     * @return Corresponding Java type
+     */
     private static String getJavaType(MappingConfig mappingConfig, String graphlType, String name, String parentTypeName) {
         Map<String, String> customTypesMapping = mappingConfig.getCustomTypesMapping();
         if (name != null && parentTypeName != null && customTypesMapping.containsKey(parentTypeName + "." + name)) {
@@ -69,8 +110,17 @@ private static String getJavaType(MappingConfig mappingConfig, String graphlType
         }
     }
 
-    static List<String> getAnnotations(MappingConfig mappingConfig, Type type, String name, String parentTypeName) {
-        return getAnnotations(mappingConfig, type, name, parentTypeName, false);
+    /**
+     * Get annotations for a given GraphQL type
+     *
+     * @param mappingConfig  Global mapping configuration
+     * @param graphlType     GraphQL type
+     * @param name           GraphQL type name
+     * @param parentTypeName Name of the parent type
+     * @return list of Java annotations for a given GraphQL type
+     */
+    static List<String> getAnnotations(MappingConfig mappingConfig, Type graphlType, String name, String parentTypeName) {
+        return getAnnotations(mappingConfig, graphlType, name, parentTypeName, false);
     }
 
     private static List<String> getAnnotations(MappingConfig mappingConfig, Type type, String name, String parentTypeName,