From f083b871c401b96b11cbf2a927b15a39fa0ad350 Mon Sep 17 00:00:00 2001 From: urielch Date: Mon, 18 Mar 2024 10:29:40 +0100 Subject: [PATCH] add somme doc to remove deployement warnings --- .../main/java/net/minidev/asm/ASMUtil.java | 6 ++ .../net/minidev/asm/BasicFiledFilter.java | 57 +++++++++++-------- .../java/net/minidev/asm/BeansAccess.java | 10 ++++ .../net/minidev/asm/BeansAccessBuilder.java | 13 ++++- .../net/minidev/asm/BeansAccessConfig.java | 9 +++ .../java/net/minidev/asm/ConvertDate.java | 13 +++++ .../net/minidev/asm/DefaultConverter.java | 6 ++ .../java/net/minidev/asm/FieldFilter.java | 1 + .../minidev/asm/ex/NoSuchFieldException.java | 4 ++ 9 files changed, 93 insertions(+), 26 deletions(-) diff --git a/accessors-smart/src/main/java/net/minidev/asm/ASMUtil.java b/accessors-smart/src/main/java/net/minidev/asm/ASMUtil.java index d343538c..1fe5b02f 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/ASMUtil.java +++ b/accessors-smart/src/main/java/net/minidev/asm/ASMUtil.java @@ -32,6 +32,12 @@ * @author uriel Chemouni */ public class ASMUtil { + /** + * default constructor + */ + public ASMUtil() { + super(); + } /** * Append the call of proper autoboxing method for the given primitive type. * diff --git a/accessors-smart/src/main/java/net/minidev/asm/BasicFiledFilter.java b/accessors-smart/src/main/java/net/minidev/asm/BasicFiledFilter.java index 5f32217d..2f5f7c5f 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/BasicFiledFilter.java +++ b/accessors-smart/src/main/java/net/minidev/asm/BasicFiledFilter.java @@ -9,52 +9,59 @@ * It serves as a default or fallback strategy when no specific field filtering logic is required. */ public class BasicFiledFilter implements FieldFilter { - /** - * A singleton instance of {@code BasicFieldFilter}. - * Since the filter does not maintain any state and allows all operations, it can be reused across the application. - */ + /** + * default constructor + */ + public BasicFiledFilter() { + super(); + } + + /** + * A singleton instance of {@code BasicFieldFilter}. + * Since the filter does not maintain any state and allows all operations, it can be reused across the application. + */ public final static BasicFiledFilter SINGLETON = new BasicFiledFilter(); /** - * Always allows using the specified field. - * - * @param field The field to check. - * @return Always returns {@code true}. - */ + * Always allows using the specified field. + * + * @param field The field to check. + * @return Always returns {@code true}. + */ @Override public boolean canUse(Field field) { return true; } /** - * Always allows using the specified field in conjunction with a method. - * - * @param field The field to check. - * @param method The method to check. This parameter is not used in the current implementation. - * @return Always returns {@code true}. - */ + * Always allows using the specified field in conjunction with a method. + * + * @param field The field to check. + * @param method The method to check. This parameter is not used in the current implementation. + * @return Always returns {@code true}. + */ @Override public boolean canUse(Field field, Method method) { return true; } /** - * Always allows reading the specified field. - * - * @param field The field to check. - * @return Always returns {@code true}. - */ + * Always allows reading the specified field. + * + * @param field The field to check. + * @return Always returns {@code true}. + */ @Override public boolean canRead(Field field) { return true; } /** - * Always allows writing to the specified field. - * - * @param field The field to check. - * @return Always returns {@code true}. - */ + * Always allows writing to the specified field. + * + * @param field The field to check. + * @return Always returns {@code true}. + */ @Override public boolean canWrite(Field field) { return true; diff --git a/accessors-smart/src/main/java/net/minidev/asm/BeansAccess.java b/accessors-smart/src/main/java/net/minidev/asm/BeansAccess.java index c563bb83..f0aa2987 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/BeansAccess.java +++ b/accessors-smart/src/main/java/net/minidev/asm/BeansAccess.java @@ -28,10 +28,18 @@ * @author uriel Chemouni */ public abstract class BeansAccess { + /** + * default constuctor + */ + public BeansAccess() { + super(); + } + private HashMap map; private Accessor[] accs; /** + * set Accessor * @param accs Accessor list */ protected void setAccessor(Accessor[] accs) { @@ -45,6 +53,7 @@ protected void setAccessor(Accessor[] accs) { } /** + * get internal map * @return a map */ public HashMap getMap() { @@ -52,6 +61,7 @@ public HashMap getMap() { } /** + * get internal accessor * @return Accessor list */ public Accessor[] getAccessors() { diff --git a/accessors-smart/src/main/java/net/minidev/asm/BeansAccessBuilder.java b/accessors-smart/src/main/java/net/minidev/asm/BeansAccessBuilder.java index a841df6d..39fce9b8 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/BeansAccessBuilder.java +++ b/accessors-smart/src/main/java/net/minidev/asm/BeansAccessBuilder.java @@ -80,7 +80,10 @@ public BeansAccessBuilder(Class type, Accessor[] accs, DynamicClassLoader loa this.accessClassNameInternal = accessClassName.replace('.', '/'); this.classNameInternal = className.replace('.', '/'); } - + /** + * register multiple new conversion + * @param conv conv list + */ public void addConversion(Iterable> conv) { if (conv == null) return; @@ -88,6 +91,10 @@ public void addConversion(Iterable> conv) { addConversion(c); } + /** + * Resister a new conversion + * @param conv the conv + */ public void addConversion(Class conv) { if (conv == null) return; @@ -106,6 +113,10 @@ public void addConversion(Class conv) { } } + /** + * build the conversion class. + * @return the new Class + */ public Class bulid() { ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS); MethodVisitor mv; diff --git a/accessors-smart/src/main/java/net/minidev/asm/BeansAccessConfig.java b/accessors-smart/src/main/java/net/minidev/asm/BeansAccessConfig.java index 421286eb..2564c6df 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/BeansAccessConfig.java +++ b/accessors-smart/src/main/java/net/minidev/asm/BeansAccessConfig.java @@ -3,7 +3,16 @@ import java.util.HashMap; import java.util.LinkedHashSet; +/** + * Beans Access Config + */ public class BeansAccessConfig { + /** + * default constructor + */ + public BeansAccessConfig() { + super(); + } /** * Field type convertor for all classes * diff --git a/accessors-smart/src/main/java/net/minidev/asm/ConvertDate.java b/accessors-smart/src/main/java/net/minidev/asm/ConvertDate.java index d79cbd4c..a6291332 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/ConvertDate.java +++ b/accessors-smart/src/main/java/net/minidev/asm/ConvertDate.java @@ -16,6 +16,12 @@ * It handles different month and day names across languages, and supports timezone adjustments. */ public class ConvertDate { + /** + * default constructor + */ + public ConvertDate() { + super(); + } static TreeMap monthsTable = new TreeMap(new StringCmpNS()); // StringCmpNS.COMP static TreeMap daysTable = new TreeMap(new StringCmpNS()); // StringCmpNS.COMP private static HashSet voidData = new HashSet(); @@ -27,6 +33,13 @@ public class ConvertDate { * Comparator for case-insensitive string comparison. Used for sorting and comparing month and day names. */ public static class StringCmpNS implements Comparator { + /** + * default constructor + */ + public StringCmpNS() { + super(); + } + @Override public int compare(String o1, String o2) { return o1.compareToIgnoreCase(o2); diff --git a/accessors-smart/src/main/java/net/minidev/asm/DefaultConverter.java b/accessors-smart/src/main/java/net/minidev/asm/DefaultConverter.java index dc112c38..587611d0 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/DefaultConverter.java +++ b/accessors-smart/src/main/java/net/minidev/asm/DefaultConverter.java @@ -10,6 +10,12 @@ */ public class DefaultConverter { /** + * Default constructor + */ + public DefaultConverter() { + super(); + } + /** * Converts the given object to an {@code int}. * * @param obj the object to convert diff --git a/accessors-smart/src/main/java/net/minidev/asm/FieldFilter.java b/accessors-smart/src/main/java/net/minidev/asm/FieldFilter.java index a911a06f..fd1f2df6 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/FieldFilter.java +++ b/accessors-smart/src/main/java/net/minidev/asm/FieldFilter.java @@ -17,6 +17,7 @@ public interface FieldFilter { public boolean canUse(Field field); /** + * Can the field be used * * @param field the field * @param method the method diff --git a/accessors-smart/src/main/java/net/minidev/asm/ex/NoSuchFieldException.java b/accessors-smart/src/main/java/net/minidev/asm/ex/NoSuchFieldException.java index eb6d2c91..07c29df5 100644 --- a/accessors-smart/src/main/java/net/minidev/asm/ex/NoSuchFieldException.java +++ b/accessors-smart/src/main/java/net/minidev/asm/ex/NoSuchFieldException.java @@ -9,11 +9,15 @@ public class NoSuchFieldException extends RuntimeException { private static final long serialVersionUID = 1L; + /** + * default constructor + */ public NoSuchFieldException() { super(); } /** + * constuctor from message. * @param message the detail message. The detail message is saved for * later retrieval by the Throwable.getMessage() method. */