Add javadoc

Author: lukebemish

src/groovy/java/dev/lukebemish/codecextras/groovy/structured/reflective/implementation/GroovyReflectiveStructureCreator.java

@@ -104,7 +104,7 @@ public String value() {
             public Function<CreationContext, List<Discoverer>> make() {
                 return context -> List.of(new Discoverer() {
                     @Override
-                    public void modifyProperties(Class<?> clazz, Map<String, java.lang.reflect.Type> known) {
+                    public void modifyProperties(Class<?> clazz, Map<String, java.lang.reflect.Type> known, java.lang.reflect.Type[] parameters) {
                         var metaClass = DefaultGroovyMethods.getMetaClass(clazz);
                         if (Objects.equals(known.get("metaClass"), MetaClass.class)) {
                             known.remove("metaClass");

src/main/java/dev/lukebemish/codecextras/structured/reflective/CreationContext.java

@@ -11,6 +11,9 @@
 import java.util.Map;
 import java.util.function.Function;
 
+/**
+ * Context provided to systems in reflective structure creation
+ */
 public final class CreationContext {
     private final Map<ReflectiveStructureCreator.CreatorSystem.Type<?, ?, ?>, Object> systems;
     private final Map<ReflectiveStructureCreator.CreatorSystem.Type<?, ?, ?>, Object> bakedSystems = new IdentityHashMap<>();
@@ -19,11 +22,21 @@ public final class CreationContext {
         this.systems = systems;
     }
 
+    /**
+     * {@return whether the given creation option is present}
+     */
     public boolean hasOption(CreationOption option) {
         var options = retrieve(CreationOptions.TYPE);
         return options.contains(option);
     }
 
+    /**
+     * Retrieves a system of the given type, baking it as necessary.
+     * @param type the type of the system to retrieve
+     * @return the system's results
+     * @param <R> the intermediary type of the system
+     * @param <T> the result type of the system
+     */
     @SuppressWarnings("unchecked")
     public synchronized <R, T> T retrieve(ReflectiveStructureCreator.CreatorSystem.Type<T, R, ?> type) {
         var existingBaked = bakedSystems.get(type);
@@ -39,6 +52,11 @@ public synchronized <R, T> T retrieve(ReflectiveStructureCreator.CreatorSystem.T
         return (T) bakedSystems.computeIfAbsent(type, t -> type.bake(type.empty(), this));
     }
 
+    /**
+     * Parses the given annotation using the {@link AnnotationParsers} system.
+     * @param annotation the annotation to parse
+     * @return the parsed annotation information
+     */
     @SuppressWarnings({"unchecked", "rawtypes"})
     public List<AnnotationParsers.AnnotationInfo<?>> parseAnnotation(Annotation annotation) {
         var annotationParsers = retrieve(AnnotationParsers.TYPE);
@@ -49,6 +67,11 @@ public List<AnnotationParsers.AnnotationInfo<?>> parseAnnotation(Annotation anno
         return List.of();
     }
 
+    /**
+     * Find a contextual transform using the {@link ContextualTransforms} system.
+     * @param elements the elements associated with the target property
+     * @return a function to transform the property's structure
+     */
     public Function<Structure<?>, Structure<?>> contextualTransform(List<AnnotatedElement> elements) {
         var contextualTransforms = retrieve(ContextualTransforms.TYPE);
         Function<Structure<?>, Structure<?>> function = Function.identity();

src/main/java/dev/lukebemish/codecextras/structured/reflective/CreationOption.java

@@ -1,3 +1,6 @@
 package dev.lukebemish.codecextras.structured.reflective;
 
+/**
+ * An option to modify reflective creation of structures.
+ */
 public interface CreationOption {}

src/main/java/dev/lukebemish/codecextras/structured/reflective/PropertyNamingOption.java

@@ -4,7 +4,13 @@
 import java.util.List;
 import java.util.Locale;
 
+/**
+ * {@link CreationOption}s for modifying the naming of properties within a structure.
+ */
 public enum PropertyNamingOption implements CreationOption {
+    /**
+     * Structure fields are given the same name as the property
+     */
     IDENTITY {
         @Override
         protected String formatPart(String part) {
@@ -16,6 +22,10 @@ protected String joinParts(List<String> parts) {
             return String.join("", parts);
         }
     },
+
+    /**
+     * Property names are converted to {@code PascalCase}
+     */
     PASCAL_CASE {
         @Override
         protected String formatPart(String part) {
@@ -27,6 +37,10 @@ protected String joinParts(List<String> parts) {
             return String.join("", parts);
         }
     },
+
+    /**
+     * Property names are converted to {@code camelCase}
+     */
     CAMEL_CASE {
         @Override
         protected String formatPart(String part) {
@@ -46,6 +60,10 @@ protected String joinParts(List<String> parts) {
             return result.toString();
         }
     },
+
+    /**
+     * Property names are converted to {@code snake_case}
+     */
     SNAKE_CASE {
         @Override
         protected String formatPart(String part) {
@@ -57,6 +75,10 @@ protected String joinParts(List<String> parts) {
             return String.join("_", parts);
         }
     },
+
+    /**
+     * Property names are converted to {@code SCREAMING_SNAKE_CASE}
+     */
     SCREAMING_SNAKE_CASE {
         @Override
         protected String formatPart(String part) {
@@ -68,6 +90,10 @@ protected String joinParts(List<String> parts) {
             return String.join("_", parts);
         }
     },
+
+    /**
+     * Property names are converted to {@code kebab-case}
+     */
     KEBAB_CASE {
         @Override
         protected String formatPart(String part) {
@@ -79,6 +105,10 @@ protected String joinParts(List<String> parts) {
             return String.join("-", parts);
         }
     },
+
+    /**
+     * Property names are converted to {@code SCREAMING-KEBAB-CASE}
+     */
     SCREAMING_KEBAB_CASE {
         @Override
         protected String formatPart(String part) {