From f33783ac1de74e98ac8f07d639854f4e48135525 Mon Sep 17 00:00:00 2001 From: Looly Date: Tue, 7 Jun 2022 15:38:36 +0800 Subject: [PATCH] fix comment --- .../core/classloader/ClassLoaderUtil.java | 17 ++++++++++------- .../cn/hutool/core/collection/CollUtil.java | 9 +++++---- .../java/cn/hutool/core/convert/Converter.java | 6 ++++-- .../main/java/cn/hutool/core/date/DateUtil.java | 3 ++- .../java/cn/hutool/core/reflect/MethodUtil.java | 2 +- .../cn/hutool/core/reflect/ReflectUtil.java | 2 +- .../cn/hutool/core/text/bloom/FuncFilter.java | 2 +- .../java/cn/hutool/core/util/ArrayUtil.java | 15 ++++++++------- .../java/cn/hutool/core/util/IdcardUtil.java | 3 +++ 9 files changed, 35 insertions(+), 24 deletions(-) diff --git a/hutool-core/src/main/java/cn/hutool/core/classloader/ClassLoaderUtil.java b/hutool-core/src/main/java/cn/hutool/core/classloader/ClassLoaderUtil.java index c42529bc4..1e9437272 100644 --- a/hutool-core/src/main/java/cn/hutool/core/classloader/ClassLoaderUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/classloader/ClassLoaderUtil.java @@ -140,7 +140,7 @@ public class ClassLoaderUtil { * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载 * * - * @param 目标类的类型 + * @param 目标类的类型 * @param name 类名 * @return 类名对应的类 * @throws UtilException 包装{@link ClassNotFoundException}，没有类名对应的类时抛出此异常 @@ -159,7 +159,7 @@ public class ClassLoaderUtil { * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载 * * - * @param 目标类的类型 + * @param 目标类的类型 * @param name 类名 * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） * @return 类名对应的类 @@ -181,6 +181,7 @@ public class ClassLoaderUtil { * 3、内部类，例如：java.lang.Thread.State会被转为java.lang.Thread$State加载 * * + * @param 加载的类的类型 * @param name 类名 * @param classLoader {@link ClassLoader}，{@code null} 则使用{@link #getClassLoader()}获取 * @param isInitialized 是否初始化类（调用static模块内容和初始化static属性） @@ -193,7 +194,7 @@ public class ClassLoaderUtil { // 自动将包名中的"/"替换为"." name = name.replace(CharPool.SLASH, CharPool.DOT); - if(null == classLoader){ + if (null == classLoader) { classLoader = getClassLoader(); } @@ -202,7 +203,7 @@ public class ClassLoaderUtil { if (clazz == null) { final String finalName = name; final ClassLoader finalClassLoader = classLoader; - clazz = CLASS_CACHE.computeIfAbsent(MapUtil.entry(name, classLoader), (key)-> doLoadClass(finalName, finalClassLoader, isInitialized)); + clazz = CLASS_CACHE.computeIfAbsent(MapUtil.entry(name, classLoader), (key) -> doLoadClass(finalName, finalClassLoader, isInitialized)); } return (Class) clazz; } @@ -284,14 +285,16 @@ public class ClassLoaderUtil { } // ----------------------------------------------------------------------------------- Private method start + /** * 加载非原始类类，无缓存 - * @param name 类名 - * @param classLoader {@link ClassLoader} + * + * @param name 类名 + * @param classLoader {@link ClassLoader} * @param isInitialized 是否初始化 * @return 类 */ - private static Class doLoadClass(final String name, ClassLoader classLoader, final boolean isInitialized){ + private static Class doLoadClass(final String name, ClassLoader classLoader, final boolean isInitialized) { Class clazz; if (name.endsWith(ARRAY_SUFFIX)) { // 对象数组"java.lang.String[]"风格 diff --git a/hutool-core/src/main/java/cn/hutool/core/collection/CollUtil.java b/hutool-core/src/main/java/cn/hutool/core/collection/CollUtil.java index b5bfc2cb2..aafcdcd63 100755 --- a/hutool-core/src/main/java/cn/hutool/core/collection/CollUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/collection/CollUtil.java @@ -750,10 +750,11 @@ public class CollUtil { * 根据函数生成的KEY去重集合，如根据Bean的某个或者某些字段完成去重。
* 去重可选是保留最先加入的值还是后加入的值 * - * @param 集合元素类型 - * @param 唯一键类型 - * @param collection 集合 - * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 + * @param 集合元素类型 + * @param 唯一键类型 + * @param collection 集合 + * @param uniqueGenerator 唯一键生成器 + * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 * @return {@link ArrayList} * @since 5.8.0 */ diff --git a/hutool-core/src/main/java/cn/hutool/core/convert/Converter.java b/hutool-core/src/main/java/cn/hutool/core/convert/Converter.java index ada1a1d96..dcd4d1cd3 100644 --- a/hutool-core/src/main/java/cn/hutool/core/convert/Converter.java +++ b/hutool-core/src/main/java/cn/hutool/core/convert/Converter.java @@ -28,12 +28,14 @@ public interface Converter { * 转换值为指定类型，可选是否不抛异常转换
* 当转换失败时返回默认值 * - * @param value 值 + * @param 目标类型 + * @param targetType 目标类型 + * @param value 值 * @param defaultValue 默认值 * @return 转换后的值 */ @SuppressWarnings("unchecked") default T convert(final Type targetType, final Object value, final T defaultValue) { - return ObjUtil.defaultIfNull((T)convert(targetType, value), defaultValue); + return ObjUtil.defaultIfNull((T) convert(targetType, value), defaultValue); } } diff --git a/hutool-core/src/main/java/cn/hutool/core/date/DateUtil.java b/hutool-core/src/main/java/cn/hutool/core/date/DateUtil.java index 32eb09d09..485127c96 100755 --- a/hutool-core/src/main/java/cn/hutool/core/date/DateUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/date/DateUtil.java @@ -99,7 +99,8 @@ public class DateUtil extends CalendarUtil { /** * 根据已有{@link Date} 产生新的{@link DateTime}对象，并根据指定时区转换 * - * @param date Date对象 + * @param date Date对象 + * @param timeZone 时区 * @return {@link DateTime}对象 */ public static DateTime date(final Date date, final TimeZone timeZone) { diff --git a/hutool-core/src/main/java/cn/hutool/core/reflect/MethodUtil.java b/hutool-core/src/main/java/cn/hutool/core/reflect/MethodUtil.java index 0eaf74075..c00ca0102 100644 --- a/hutool-core/src/main/java/cn/hutool/core/reflect/MethodUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/reflect/MethodUtil.java @@ -565,7 +565,7 @@ public class MethodUtil { * @param method 方法（对象方法或static方法都可） * @param args 参数对象 * @return 结果 - * @throws InvocationTargetRuntimeException 目标方法执行异常 + * @throws InvocationTargetException 目标方法执行异常 * @throws IllegalAccessException 访问权限异常 */ @SuppressWarnings("unchecked") diff --git a/hutool-core/src/main/java/cn/hutool/core/reflect/ReflectUtil.java b/hutool-core/src/main/java/cn/hutool/core/reflect/ReflectUtil.java index 77e21549f..54a995229 100644 --- a/hutool-core/src/main/java/cn/hutool/core/reflect/ReflectUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/reflect/ReflectUtil.java @@ -33,7 +33,7 @@ public class ReflectUtil { * * @param executable 可执行的反射对象 * @return 描述符 - * @apiNote 参考：jvm定义的Field Descriptors（字段描述） + * 参考：jvm定义的Field Descriptors（字段描述） *

例：

*
    *
  • {@code ReflectUtil.getDescriptor(Object.class.getMethod("hashCode")) // "()I"}
    • diff --git a/hutool-core/src/main/java/cn/hutool/core/text/bloom/FuncFilter.java b/hutool-core/src/main/java/cn/hutool/core/text/bloom/FuncFilter.java index 99f3ed96a..b28456519 100644 --- a/hutool-core/src/main/java/cn/hutool/core/text/bloom/FuncFilter.java +++ b/hutool-core/src/main/java/cn/hutool/core/text/bloom/FuncFilter.java @@ -16,7 +16,7 @@ public class FuncFilter extends AbstractFilter { * * @param size 最大值 * @param hashFunc Hash函数 - * @return + * @return FuncFilter */ public static FuncFilter of(final int size, final Function hashFunc) { return new FuncFilter(size, hashFunc); diff --git a/hutool-core/src/main/java/cn/hutool/core/util/ArrayUtil.java b/hutool-core/src/main/java/cn/hutool/core/util/ArrayUtil.java index 83060fb9d..ed613a297 100755 --- a/hutool-core/src/main/java/cn/hutool/core/util/ArrayUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/util/ArrayUtil.java @@ -348,7 +348,7 @@ public class ArrayUtil extends PrimitiveArrayUtil { Array.set(buffer, index, value); return buffer; } else { - if(ArrayUtil.isEmpty(buffer)){ + if (ArrayUtil.isEmpty(buffer)) { final T[] values = newArray(value.getClass(), 1); values[0] = value; return append(buffer, values); @@ -1644,10 +1644,11 @@ public class ArrayUtil extends PrimitiveArrayUtil { * 去重数组中的元素，去重后生成新的数组，原数组不变
    * 此方法通过{@link LinkedHashSet} 去重 * - * @param 数组元素类型 - * @param 唯一键类型 - * @param array 数组 - * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 + * @param 数组元素类型 + * @param 唯一键类型 + * @param array 数组 + * @param uniqueGenerator 唯一键生成器 + * @param override 是否覆盖模式，如果为{@code true}，加入的新值会覆盖相同key的旧值，否则会忽略新加值 * @return 去重后的数组 * @since 5.8.0 */ @@ -1658,9 +1659,9 @@ public class ArrayUtil extends PrimitiveArrayUtil { } final UniqueKeySet set = new UniqueKeySet<>(true, uniqueGenerator); - if(override){ + if (override) { Collections.addAll(set, array); - } else{ + } else { for (final T t : array) { set.addIfAbsent(t); } diff --git a/hutool-core/src/main/java/cn/hutool/core/util/IdcardUtil.java b/hutool-core/src/main/java/cn/hutool/core/util/IdcardUtil.java index 3bf357b46..b09afc98a 100755 --- a/hutool-core/src/main/java/cn/hutool/core/util/IdcardUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/util/IdcardUtil.java @@ -638,6 +638,9 @@ public class IdcardUtil { * 参考文档《港澳居民来往内地通行证号码规则》： * https://www.hmo.gov.cn/fwga_new/wldjnd/201711/t20171120_1333.html *

    + * + * @param idCard 身份证号码 + * @return 是否有效 */ public static boolean isValidHkMoHomeReturn(final String idCard) { if (StrUtil.isEmpty(idCard)) {