Add javadocs to utility classes

src/main/java/eu/koboo/en2do/utility/AnnotationUtils.java

@@ -7,9 +7,21 @@
 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * A utility class for everything related to annotations
+ */
 @UtilityClass
 public class AnnotationUtils {
 
+    /**
+     * This method is ued to get all annotations from an entity class, using while loop,
+     * to iterate through all super-types.
+     * @param entityClass The class, which should be scanned.
+     * @param annotationClass the searched annotation
+     * @return The Set with all found annotations of type A
+     * @param <E> The generic type of the Class
+     * @param <A> The generic type of the annotation Class
+     */
     public <E, A extends Annotation> Set<A> collectAnnotations(Class<E> entityClass, Class<A> annotationClass) {
         Set<A> annotationSet = new HashSet<>();
         Class<?> clazz = entityClass;

src/main/java/eu/koboo/en2do/utility/DateUtils.java

@@ -10,6 +10,9 @@
 import java.util.TimeZone;
 import java.util.concurrent.TimeUnit;
 
+/**
+ * A utility class for working with "java.util.Date".
+ */
 @UtilityClass
 @SuppressWarnings("unused")
 public class DateUtils {

src/main/java/eu/koboo/en2do/utility/EntityUtils.java

@@ -10,9 +10,18 @@
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * A utility class for everything related to entity properties.
+ */
 @UtilityClass
 public class EntityUtils {
 
+    /**
+     * This method is used to copy all field values from one entity to another.
+     * It also works with inheritance.
+     * @param from The entity to copy from
+     * @param to The entity to copy to
+     */
     public void copyProperties(Object from, Object to) {
         Class<?> fromClass = from.getClass();
         Class<?> toClass = to.getClass();

src/main/java/eu/koboo/en2do/utility/FieldUtils.java

@@ -7,9 +7,18 @@
 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * A utility class for everything related to fields.
+ */
 @UtilityClass
 public class FieldUtils {
 
+    /**
+     * This method is used to scan a class for all fields.
+     * @param typeClass The class, which should be scanned
+     * @return The Set with all found fields of the given class.
+     * @param <E> The generic type of the class
+     */
     public <E> Set<Field> collectFields(Class<E> typeClass) {
         Set<Field> fields = new HashSet<>();
         Class<?> clazz = typeClass;
@@ -24,6 +33,12 @@ public <E> Set<Field> collectFields(Class<E> typeClass) {
         return fields;
     }
 
+    /**
+     * This method is used to iterate through a set of fields and search for a field by its name.
+     * @param fieldName The field name, which should be searched.
+     * @param fieldSet The Set, which should be iterated through
+     * @return The field, if found. If not found, it returns "null"
+     */
     public Field findFieldByName(String fieldName, Set<Field> fieldSet) {
         for (Field field : fieldSet) {
             if (!field.getName().equalsIgnoreCase(fieldName)) {

src/main/java/eu/koboo/en2do/utility/GenericUtils.java

@@ -7,6 +7,9 @@
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 
+/**
+ * A utility class for everything related to generic types or class types.
+ */
 @UtilityClass
 public class GenericUtils {