Skip to content

Commit 8346cf4

Browse files
authored
add somme doc to remove deployement warnings (#184)
1 parent def22d8 commit 8346cf4

9 files changed

+93
-26
lines changed

accessors-smart/src/main/java/net/minidev/asm/ASMUtil.java

+6
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@
3232
* @author uriel Chemouni
3333
*/
3434
public class ASMUtil {
35+
/**
36+
* default constructor
37+
*/
38+
public ASMUtil() {
39+
super();
40+
}
3541
/**
3642
* Append the call of proper autoboxing method for the given primitive type.
3743
*

accessors-smart/src/main/java/net/minidev/asm/BasicFiledFilter.java

+32-25
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,59 @@
99
* It serves as a default or fallback strategy when no specific field filtering logic is required.
1010
*/
1111
public class BasicFiledFilter implements FieldFilter {
12-
/**
13-
* A singleton instance of {@code BasicFieldFilter}.
14-
* Since the filter does not maintain any state and allows all operations, it can be reused across the application.
15-
*/
12+
/**
13+
* default constructor
14+
*/
15+
public BasicFiledFilter() {
16+
super();
17+
}
18+
19+
/**
20+
* A singleton instance of {@code BasicFieldFilter}.
21+
* Since the filter does not maintain any state and allows all operations, it can be reused across the application.
22+
*/
1623
public final static BasicFiledFilter SINGLETON = new BasicFiledFilter();
1724

1825
/**
19-
* Always allows using the specified field.
20-
*
21-
* @param field The field to check.
22-
* @return Always returns {@code true}.
23-
*/
26+
* Always allows using the specified field.
27+
*
28+
* @param field The field to check.
29+
* @return Always returns {@code true}.
30+
*/
2431
@Override
2532
public boolean canUse(Field field) {
2633
return true;
2734
}
2835

2936
/**
30-
* Always allows using the specified field in conjunction with a method.
31-
*
32-
* @param field The field to check.
33-
* @param method The method to check. This parameter is not used in the current implementation.
34-
* @return Always returns {@code true}.
35-
*/
37+
* Always allows using the specified field in conjunction with a method.
38+
*
39+
* @param field The field to check.
40+
* @param method The method to check. This parameter is not used in the current implementation.
41+
* @return Always returns {@code true}.
42+
*/
3643
@Override
3744
public boolean canUse(Field field, Method method) {
3845
return true;
3946
}
4047

4148
/**
42-
* Always allows reading the specified field.
43-
*
44-
* @param field The field to check.
45-
* @return Always returns {@code true}.
46-
*/
49+
* Always allows reading the specified field.
50+
*
51+
* @param field The field to check.
52+
* @return Always returns {@code true}.
53+
*/
4754
@Override
4855
public boolean canRead(Field field) {
4956
return true;
5057
}
5158

5259
/**
53-
* Always allows writing to the specified field.
54-
*
55-
* @param field The field to check.
56-
* @return Always returns {@code true}.
57-
*/
60+
* Always allows writing to the specified field.
61+
*
62+
* @param field The field to check.
63+
* @return Always returns {@code true}.
64+
*/
5865
@Override
5966
public boolean canWrite(Field field) {
6067
return true;

accessors-smart/src/main/java/net/minidev/asm/BeansAccess.java

+10
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,18 @@
2828
* @author uriel Chemouni
2929
*/
3030
public abstract class BeansAccess<T> {
31+
/**
32+
* default constuctor
33+
*/
34+
public BeansAccess() {
35+
super();
36+
}
37+
3138
private HashMap<String, Accessor> map;
3239
private Accessor[] accs;
3340

3441
/**
42+
* set Accessor
3543
* @param accs Accessor list
3644
*/
3745
protected void setAccessor(Accessor[] accs) {
@@ -45,13 +53,15 @@ protected void setAccessor(Accessor[] accs) {
4553
}
4654

4755
/**
56+
* get internal map
4857
* @return a map
4958
*/
5059
public HashMap<String, Accessor> getMap() {
5160
return map;
5261
}
5362

5463
/**
64+
* get internal accessor
5565
* @return Accessor list
5666
*/
5767
public Accessor[] getAccessors() {

accessors-smart/src/main/java/net/minidev/asm/BeansAccessBuilder.java

+12-1
Original file line numberDiff line numberDiff line change
@@ -80,14 +80,21 @@ public BeansAccessBuilder(Class<?> type, Accessor[] accs, DynamicClassLoader loa
8080
this.accessClassNameInternal = accessClassName.replace('.', '/');
8181
this.classNameInternal = className.replace('.', '/');
8282
}
83-
83+
/**
84+
* register multiple new conversion
85+
* @param conv conv list
86+
*/
8487
public void addConversion(Iterable<Class<?>> conv) {
8588
if (conv == null)
8689
return;
8790
for (Class<?> c : conv)
8891
addConversion(c);
8992
}
9093

94+
/**
95+
* Resister a new conversion
96+
* @param conv the conv
97+
*/
9198
public void addConversion(Class<?> conv) {
9299
if (conv == null)
93100
return;
@@ -106,6 +113,10 @@ public void addConversion(Class<?> conv) {
106113
}
107114
}
108115

116+
/**
117+
* build the conversion class.
118+
* @return the new Class
119+
*/
109120
public Class<?> bulid() {
110121
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
111122
MethodVisitor mv;

accessors-smart/src/main/java/net/minidev/asm/BeansAccessConfig.java

+9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
import java.util.HashMap;
44
import java.util.LinkedHashSet;
55

6+
/**
7+
* Beans Access Config
8+
*/
69
public class BeansAccessConfig {
10+
/**
11+
* default constructor
12+
*/
13+
public BeansAccessConfig() {
14+
super();
15+
}
716
/**
817
* Field type convertor for all classes
918
*

accessors-smart/src/main/java/net/minidev/asm/ConvertDate.java

+13
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
* It handles different month and day names across languages, and supports timezone adjustments.
1717
*/
1818
public class ConvertDate {
19+
/**
20+
* default constructor
21+
*/
22+
public ConvertDate() {
23+
super();
24+
}
1925
static TreeMap<String, Integer> monthsTable = new TreeMap<String, Integer>(new StringCmpNS()); // StringCmpNS.COMP
2026
static TreeMap<String, Integer> daysTable = new TreeMap<String, Integer>(new StringCmpNS()); // StringCmpNS.COMP
2127
private static HashSet<String> voidData = new HashSet<String>();
@@ -27,6 +33,13 @@ public class ConvertDate {
2733
* Comparator for case-insensitive string comparison. Used for sorting and comparing month and day names.
2834
*/
2935
public static class StringCmpNS implements Comparator<String> {
36+
/**
37+
* default constructor
38+
*/
39+
public StringCmpNS() {
40+
super();
41+
}
42+
3043
@Override
3144
public int compare(String o1, String o2) {
3245
return o1.compareToIgnoreCase(o2);

accessors-smart/src/main/java/net/minidev/asm/DefaultConverter.java

+6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010
*/
1111
public class DefaultConverter {
1212
/**
13+
* Default constructor
14+
*/
15+
public DefaultConverter() {
16+
super();
17+
}
18+
/**
1319
* Converts the given object to an {@code int}.
1420
*
1521
* @param obj the object to convert

accessors-smart/src/main/java/net/minidev/asm/FieldFilter.java

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ public interface FieldFilter {
1717
public boolean canUse(Field field);
1818

1919
/**
20+
* Can the field be used
2021
*
2122
* @param field the field
2223
* @param method the method

accessors-smart/src/main/java/net/minidev/asm/ex/NoSuchFieldException.java

+4
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@
99
public class NoSuchFieldException extends RuntimeException {
1010
private static final long serialVersionUID = 1L;
1111

12+
/**
13+
* default constructor
14+
*/
1215
public NoSuchFieldException() {
1316
super();
1417
}
1518

1619
/**
20+
* constuctor from message.
1721
* @param message the detail message. The detail message is saved for
1822
* later retrieval by the Throwable.getMessage() method.
1923
*/

0 commit comments

Comments
 (0)