diff --git a/src/org/redkale/boot/ClassFilter.java b/src/org/redkale/boot/ClassFilter.java index d9524b0bd..08aa9b47e 100644 --- a/src/org/redkale/boot/ClassFilter.java +++ b/src/org/redkale/boot/ClassFilter.java @@ -26,7 +26,7 @@ import java.util.regex.*; * 详情见: http://www.redkale.org * * @author zhangjx - * @param + * @param 泛型 */ public final class ClassFilter { diff --git a/src/org/redkale/convert/ext/BigIntegerSimpledCoder.java b/src/org/redkale/convert/ext/BigIntegerSimpledCoder.java index e29d57f43..e958bfa2c 100644 --- a/src/org/redkale/convert/ext/BigIntegerSimpledCoder.java +++ b/src/org/redkale/convert/ext/BigIntegerSimpledCoder.java @@ -12,10 +12,12 @@ import java.math.BigInteger; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class BigIntegerSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/BoolArraySimpledCoder.java b/src/org/redkale/convert/ext/BoolArraySimpledCoder.java index 494e300fc..a14e55987 100644 --- a/src/org/redkale/convert/ext/BoolArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/BoolArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class BoolArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/BoolSimpledCoder.java b/src/org/redkale/convert/ext/BoolSimpledCoder.java index 3b4df3633..49647bf83 100644 --- a/src/org/redkale/convert/ext/BoolSimpledCoder.java +++ b/src/org/redkale/convert/ext/BoolSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class BoolSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/ByteArraySimpledCoder.java b/src/org/redkale/convert/ext/ByteArraySimpledCoder.java index d55cf65c3..9772e1491 100644 --- a/src/org/redkale/convert/ext/ByteArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/ByteArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class ByteArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/ByteSimpledCoder.java b/src/org/redkale/convert/ext/ByteSimpledCoder.java index e9cb9b42a..4b9a6c486 100644 --- a/src/org/redkale/convert/ext/ByteSimpledCoder.java +++ b/src/org/redkale/convert/ext/ByteSimpledCoder.java @@ -11,10 +11,12 @@ import org.redkale.convert.Writer; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class ByteSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/CharArraySimpledCoder.java b/src/org/redkale/convert/ext/CharArraySimpledCoder.java index 96f349404..f3b9173b6 100644 --- a/src/org/redkale/convert/ext/CharArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/CharArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class CharArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/CharSequenceSimpledCoder.java b/src/org/redkale/convert/ext/CharSequenceSimpledCoder.java index db0a6547d..bec1bdffe 100644 --- a/src/org/redkale/convert/ext/CharSequenceSimpledCoder.java +++ b/src/org/redkale/convert/ext/CharSequenceSimpledCoder.java @@ -11,8 +11,8 @@ import org.redkale.convert.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public class CharSequenceSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/CharSimpledCoder.java b/src/org/redkale/convert/ext/CharSimpledCoder.java index 8e014d322..520988679 100644 --- a/src/org/redkale/convert/ext/CharSimpledCoder.java +++ b/src/org/redkale/convert/ext/CharSimpledCoder.java @@ -14,8 +14,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class CharSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/CompletionHandlerSimpledCoder.java b/src/org/redkale/convert/ext/CompletionHandlerSimpledCoder.java index 07832ce1e..5cf2c0daf 100644 --- a/src/org/redkale/convert/ext/CompletionHandlerSimpledCoder.java +++ b/src/org/redkale/convert/ext/CompletionHandlerSimpledCoder.java @@ -12,8 +12,8 @@ import org.redkale.convert.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class CompletionHandlerSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/DLongSimpledCoder.java b/src/org/redkale/convert/ext/DLongSimpledCoder.java index 13da9869d..dd9b148b5 100644 --- a/src/org/redkale/convert/ext/DLongSimpledCoder.java +++ b/src/org/redkale/convert/ext/DLongSimpledCoder.java @@ -14,8 +14,8 @@ import org.redkale.util.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class DLongSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/DateSimpledCoder.java b/src/org/redkale/convert/ext/DateSimpledCoder.java index edac62cd9..b5a1317ce 100644 --- a/src/org/redkale/convert/ext/DateSimpledCoder.java +++ b/src/org/redkale/convert/ext/DateSimpledCoder.java @@ -14,8 +14,8 @@ import java.util.Date; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class DateSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/DoubleArraySimpledCoder.java b/src/org/redkale/convert/ext/DoubleArraySimpledCoder.java index 570da7cd6..afff5f5eb 100644 --- a/src/org/redkale/convert/ext/DoubleArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/DoubleArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class DoubleArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/DoubleSimpledCoder.java b/src/org/redkale/convert/ext/DoubleSimpledCoder.java index 10e1edb4c..53a3f8623 100644 --- a/src/org/redkale/convert/ext/DoubleSimpledCoder.java +++ b/src/org/redkale/convert/ext/DoubleSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class DoubleSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/EnumSimpledCoder.java b/src/org/redkale/convert/ext/EnumSimpledCoder.java index f214c0369..939a2dd37 100644 --- a/src/org/redkale/convert/ext/EnumSimpledCoder.java +++ b/src/org/redkale/convert/ext/EnumSimpledCoder.java @@ -15,9 +15,9 @@ import org.redkale.convert.Writer; * 详情见: http://www.redkale.org * * @author zhangjx - * @param - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 + * @param Enum的子类 */ public final class EnumSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/FloatArraySimpledCoder.java b/src/org/redkale/convert/ext/FloatArraySimpledCoder.java index 45f8b4e92..c1435214f 100644 --- a/src/org/redkale/convert/ext/FloatArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/FloatArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class FloatArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/FloatSimpledCoder.java b/src/org/redkale/convert/ext/FloatSimpledCoder.java index 2c7b40378..6e99f05ea 100644 --- a/src/org/redkale/convert/ext/FloatSimpledCoder.java +++ b/src/org/redkale/convert/ext/FloatSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class FloatSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/InetAddressSimpledCoder.java b/src/org/redkale/convert/ext/InetAddressSimpledCoder.java index 211192f88..a2f2391bc 100644 --- a/src/org/redkale/convert/ext/InetAddressSimpledCoder.java +++ b/src/org/redkale/convert/ext/InetAddressSimpledCoder.java @@ -14,8 +14,8 @@ import java.net.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class InetAddressSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/IntArraySimpledCoder.java b/src/org/redkale/convert/ext/IntArraySimpledCoder.java index 99fc779e9..af9000d1a 100644 --- a/src/org/redkale/convert/ext/IntArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/IntArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class IntArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/IntSimpledCoder.java b/src/org/redkale/convert/ext/IntSimpledCoder.java index 96d855bb5..a1885b7f2 100644 --- a/src/org/redkale/convert/ext/IntSimpledCoder.java +++ b/src/org/redkale/convert/ext/IntSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class IntSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/LongArraySimpledCoder.java b/src/org/redkale/convert/ext/LongArraySimpledCoder.java index c727e748f..790235286 100644 --- a/src/org/redkale/convert/ext/LongArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/LongArraySimpledCoder.java @@ -11,10 +11,12 @@ import org.redkale.convert.Writer; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class LongArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/LongSimpledCoder.java b/src/org/redkale/convert/ext/LongSimpledCoder.java index 4009d2b5c..2446485bd 100644 --- a/src/org/redkale/convert/ext/LongSimpledCoder.java +++ b/src/org/redkale/convert/ext/LongSimpledCoder.java @@ -14,8 +14,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class LongSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/NumberSimpledCoder.java b/src/org/redkale/convert/ext/NumberSimpledCoder.java index 2f9674766..6ab543e7d 100644 --- a/src/org/redkale/convert/ext/NumberSimpledCoder.java +++ b/src/org/redkale/convert/ext/NumberSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class NumberSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/PatternSimpledCoder.java b/src/org/redkale/convert/ext/PatternSimpledCoder.java index 7dc68d2f4..dc720e824 100644 --- a/src/org/redkale/convert/ext/PatternSimpledCoder.java +++ b/src/org/redkale/convert/ext/PatternSimpledCoder.java @@ -12,8 +12,8 @@ import org.redkale.convert.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public class PatternSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/ShortArraySimpledCoder.java b/src/org/redkale/convert/ext/ShortArraySimpledCoder.java index 4864bc942..fb178fda5 100644 --- a/src/org/redkale/convert/ext/ShortArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/ShortArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class ShortArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/ShortSimpledCoder.java b/src/org/redkale/convert/ext/ShortSimpledCoder.java index dc1675313..a46a23dc6 100644 --- a/src/org/redkale/convert/ext/ShortSimpledCoder.java +++ b/src/org/redkale/convert/ext/ShortSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class ShortSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/StringArraySimpledCoder.java b/src/org/redkale/convert/ext/StringArraySimpledCoder.java index 42c82d1f6..a95975296 100644 --- a/src/org/redkale/convert/ext/StringArraySimpledCoder.java +++ b/src/org/redkale/convert/ext/StringArraySimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class StringArraySimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/StringSimpledCoder.java b/src/org/redkale/convert/ext/StringSimpledCoder.java index d6088f454..09f573853 100644 --- a/src/org/redkale/convert/ext/StringSimpledCoder.java +++ b/src/org/redkale/convert/ext/StringSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.Writer; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public final class StringSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/convert/ext/TypeSimpledCoder.java b/src/org/redkale/convert/ext/TypeSimpledCoder.java index 5a24c8acb..a98f7df5e 100644 --- a/src/org/redkale/convert/ext/TypeSimpledCoder.java +++ b/src/org/redkale/convert/ext/TypeSimpledCoder.java @@ -13,8 +13,8 @@ import org.redkale.convert.SimpledCoder; * *

详情见: http://www.redkale.org * @author zhangjx - * @param - * @param + * @param Reader输入的子类型 + * @param Writer输出的子类型 */ public class TypeSimpledCoder extends SimpledCoder { diff --git a/src/org/redkale/net/sncp/ServiceWrapper.java b/src/org/redkale/net/sncp/ServiceWrapper.java index 0e6df05cb..66b2fb037 100644 --- a/src/org/redkale/net/sncp/ServiceWrapper.java +++ b/src/org/redkale/net/sncp/ServiceWrapper.java @@ -15,7 +15,7 @@ import org.redkale.boot.*; * *

详情见: http://www.redkale.org * @author zhangjx - * @param + * @param Service的子类 */ public final class ServiceWrapper { diff --git a/src/org/redkale/net/sncp/Sncp.java b/src/org/redkale/net/sncp/Sncp.java index c3fc4e57d..c399baee4 100644 --- a/src/org/redkale/net/sncp/Sncp.java +++ b/src/org/redkale/net/sncp/Sncp.java @@ -27,7 +27,9 @@ import org.redkale.service.DynRemote; * Service Node Communicate Protocol * 生成Service的本地模式或远程模式Service-Class的工具类 * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ public abstract class Sncp { @@ -86,8 +88,8 @@ public abstract class Sncp { /** * 对类名或者name字符串进行hash。 * - * @param name - * @return + * @param name String + * @return hash值 */ public static DLong hash(final String name) { if (name == null || name.isEmpty()) return DLong.ZERO; @@ -179,10 +181,10 @@ public abstract class Sncp { * * 创建Service的本地模式Class * - * @param - * @param name - * @param serviceClass - * @return + * @param Service子类 + * @param name 资源名 + * @param serviceClass Service类 + * @return Service实例 */ @SuppressWarnings("unchecked") public static Class createLocalServiceClass(final String name, final Class serviceClass) { @@ -645,15 +647,15 @@ public abstract class Sncp { * * 创建本地模式Service实例 * - * @param - * @param name - * @param executor - * @param serviceClass - * @param clientAddress - * @param groups - * @param sameGroupTransports - * @param diffGroupTransports - * @return + * @param Service泛型 + * @param name 资源名 + * @param executor 线程池 + * @param serviceClass Service类 + * @param clientAddress 本地IP地址 + * @param groups 含同组和异组的组集合 + * @param sameGroupTransports 同组的通信组件列表 + * @param diffGroupTransports 异组的通信组件列表 + * @return Service的本地模式实例 */ @SuppressWarnings("unchecked") public static T createLocalService(final String name, final Consumer executor, final Class serviceClass, @@ -805,15 +807,16 @@ public abstract class Sncp { * * * 创建远程模式的Service实例 - *

- * @param - * @param name - * @param executor - * @param serviceClass - * @param clientAddress - * @param groups - * @param transport - * @return + * + * @param Service泛型 + * @param name 资源名 + * @param executor 线程池 + * @param serviceClass Service类 + * @param clientAddress 本地IP地址 + * @param groups 含同组和异组的组集合 + * + * @param transport 通信组件 + * @return Service的远程模式实例 */ @SuppressWarnings("unchecked") public static T createRemoteService(final String name, final Consumer executor, final Class serviceClass, diff --git a/src/org/redkale/net/sncp/SncpDynServlet.java b/src/org/redkale/net/sncp/SncpDynServlet.java index d12b5c377..706b88ba9 100644 --- a/src/org/redkale/net/sncp/SncpDynServlet.java +++ b/src/org/redkale/net/sncp/SncpDynServlet.java @@ -24,7 +24,9 @@ import org.redkale.service.DynCall; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ public final class SncpDynServlet extends SncpServlet { @@ -138,35 +140,34 @@ public final class SncpDynServlet extends SncpServlet { out.writeByte((byte) 0); } - /** ** - * - * public class TestService implements Service { - * public boolean change(TestBean bean, String name, int id) { - * - * } - * } - * - * public class DynActionTestService_change extends SncpServletAction { - * - * public TestService service; - * - * @Override - * public void action(final BsonReader in, final BsonWriter out) throws Throwable { - * TestBean arg1 = convert.convertFrom(in, paramTypes[1]); - * String arg2 = convert.convertFrom(in, paramTypes[2]); - * int arg3 = convert.convertFrom(in, paramTypes[3]); - * Object rs = service.change(arg1, arg2, arg3); - * callParameter(out, arg1, arg2, arg3); - * convert.convertTo(out, paramTypes[0], rs); - * } - * } - */ /** + *

+         *  public class TestService implements Service {
+         *      public boolean change(TestBean bean, String name, int id) {
          *
-         * @param service
-         * @param actionid
-         * @param method
-         * @return
+         *      }
+         *  }
+         *
+         *  public class DynActionTestService_change extends SncpServletAction {
+         *
+         *      public TestService service;
+         *
+         *      @Override
+         *      public void action(final BsonReader in, final BsonWriter out) throws Throwable {
+         *          TestBean arg1 = convert.convertFrom(in, paramTypes[1]);
+         *          String arg2 = convert.convertFrom(in, paramTypes[2]);
+         *          int arg3 = convert.convertFrom(in, paramTypes[3]);
+         *          Object rs = service.change(arg1, arg2, arg3);
+         *          callParameter(out, arg1, arg2, arg3);
+         *          convert.convertTo(out, paramTypes[0], rs);
+         *      }
+         *  }
+         * 
+ * + * @param service Service + * @param actionid 操作ID + * @param method 方法 + * @return SncpServletAction */ @SuppressWarnings("unchecked") public static SncpServletAction create(final Service service, final DLong actionid, final Method method) { diff --git a/src/org/redkale/service/CacheSourceService.java b/src/org/redkale/service/CacheSourceService.java index 0cef685fa..7a2c8bcf7 100644 --- a/src/org/redkale/service/CacheSourceService.java +++ b/src/org/redkale/service/CacheSourceService.java @@ -21,9 +21,10 @@ import org.redkale.util.*; /** * - * @param - * @param - *

详情见: http://www.redkale.org + * @param key类型 + * @param value类型 + *

+ * 详情见: http://www.redkale.org * @author zhangjx */ @AutoLoad(false) diff --git a/src/org/redkale/service/RetResult.java b/src/org/redkale/service/RetResult.java index d49fa125f..4e8406026 100644 --- a/src/org/redkale/service/RetResult.java +++ b/src/org/redkale/service/RetResult.java @@ -10,9 +10,11 @@ import org.redkale.convert.json.*; /** * 通用的结果对象,在常见的HTTP+JSON接口中返回的结果需要含结果码,错误信息,和实体对象。 * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param + * @param 结果对象的泛型 */ public class RetResult { @@ -67,7 +69,7 @@ public class RetResult { /** * 判断结果是否成功返回, retcode = 0 视为成功, 否则视为错误码 * - * @return + * @return 是否成功 */ public boolean isSuccess() { return retcode == 0; @@ -76,7 +78,7 @@ public class RetResult { /** * 结果码 0表示成功、 非0表示错误 * - * @return + * @return 结果码 */ public int getRetcode() { return retcode; @@ -97,7 +99,7 @@ public class RetResult { /** * 结果对象, 通常只有在retcode = 0时值才有效 * - * @return + * @return 结果对象 */ public T getResult() { return result; diff --git a/src/org/redkale/service/Service.java b/src/org/redkale/service/Service.java index d0f51beb2..0c314ff44 100644 --- a/src/org/redkale/service/Service.java +++ b/src/org/redkale/service/Service.java @@ -12,11 +12,13 @@ import org.redkale.util.*; * 注意: "$"是一个很特殊的Service.name值 。 被标记为@Resource(name = "$") 的Service的资源名与所属父Service的资源名一致。 * *

- * @Resource(name = ".*") - * private HashMap nodemap; + * @Resource(name = ".*") + * private HashMap<String, XXXService> nodemap; * 被注入的多个XXXService实例 但不会包含自身的XXXService。 * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ public interface Service { @@ -24,20 +26,25 @@ public interface Service { /** * 该方法必须是可以重复调用, 当reload时需要重复调用init方法 * - * @param config + * @param config 配置参数 */ default void init(AnyValue config) { } + /** + * 进程退出时,调用Service销毁 + * + * @param config 配置参数 + */ default void destroy(AnyValue config) { } /** * Service的name, 一个Service在同一进程内可以包含多个实例, 使用name区分 - *

- * @return + * + * @return 资源名 */ default String name() { return ""; diff --git a/src/org/redkale/source/CacheSource.java b/src/org/redkale/source/CacheSource.java index 0d9bf71b9..5ca879b13 100644 --- a/src/org/redkale/source/CacheSource.java +++ b/src/org/redkale/source/CacheSource.java @@ -11,8 +11,8 @@ import java.util.*; /** * - * @param - * @param + * @param key的类型 + * @param value的类型 *

详情见: http://www.redkale.org * @author zhangjx */ diff --git a/src/org/redkale/source/DataCallArrayAttribute.java b/src/org/redkale/source/DataCallArrayAttribute.java index 8bad57270..405707b2e 100644 --- a/src/org/redkale/source/DataCallArrayAttribute.java +++ b/src/org/redkale/source/DataCallArrayAttribute.java @@ -11,10 +11,12 @@ import org.redkale.util.*; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param - * @param + * @param Entity类的类型 + * @param 字段的类型 */ public final class DataCallArrayAttribute implements Attribute { diff --git a/src/org/redkale/source/DataDefaultSource.java b/src/org/redkale/source/DataDefaultSource.java index c32e43110..22d121742 100644 --- a/src/org/redkale/source/DataDefaultSource.java +++ b/src/org/redkale/source/DataDefaultSource.java @@ -22,7 +22,9 @@ import org.redkale.util.*; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ @SuppressWarnings("unchecked") @@ -286,9 +288,9 @@ public final class DataDefaultSource implements DataSource, Function - * @param - * @param clazz + * + * @param Entity类泛型 + * @param clazz Entity类 */ public void refreshCache(Class clazz) { EntityInfo info = loadEntityInfo(clazz); @@ -301,8 +303,8 @@ public final class DataDefaultSource implements DataSource, Function - * @param values + * @param Entity类泛型 + * @param values Entity对象 */ @Override public void insert(T... values) { @@ -478,8 +480,8 @@ public final class DataDefaultSource implements DataSource, Function - * @param values + * @param Entity类泛型 + * @param values Entity对象 */ @Override public void delete(T... values) { @@ -616,8 +618,8 @@ public final class DataDefaultSource implements DataSource, Function - * @param values + * @param Entity类泛型 + * @param values Entity对象 */ @Override public void update(T... values) { @@ -705,11 +707,11 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param id - * @param column - * @param value + * @param Entity类的泛型 + * @param clazz Entity类 + * @param id 主键值 + * @param column 过滤字段名 + * @param value 过滤字段值 */ @Override public void updateColumn(Class clazz, Serializable id, String column, Serializable value) { @@ -757,12 +759,13 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param id - * @param column - * @param incvalue + * @param Entity类的泛型 + * @param clazz Entity类 + * @param id 主键值 + * @param column 字段名 + * @param incvalue 字段加值 */ @Override public void updateColumnIncrement(Class clazz, Serializable id, String column, long incvalue) { @@ -812,12 +815,13 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param id - * @param column - * @param andvalue + * @param Entity类的泛型 + * @param clazz Entity类 + * @param id 主键值 + * @param column 字段名 + * @param andvalue 字段与值 */ @Override public void updateColumnAnd(Class clazz, Serializable id, String column, long andvalue) { @@ -867,12 +871,13 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param id - * @param column - * @param orvalue + * @param Entity类的泛型 + * @param clazz Entity类 + * @param id 主键值 + * @param column 字段名 + * @param orvalue 字段或值 */ @Override public void updateColumnOr(Class clazz, Serializable id, String column, long orvalue) { @@ -923,9 +928,9 @@ public final class DataDefaultSource implements DataSource, Function - * @param value - * @param columns + * @param Entity类的泛型 + * @param value Entity对象 + * @param columns 需要更新的字段 */ @Override public void updateColumns(final T value, final String... columns) { @@ -1134,10 +1139,10 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param pk - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param pk 主键值 + * @return Entity对象 */ @Override public T find(Class clazz, Serializable pk) { @@ -1404,13 +1409,13 @@ public final class DataDefaultSource implements DataSource, Function - * @param - * @param - * @param selectedColumn - * @param clazz - * @param flipper - * @param bean - * @return + * @param Entity类的泛型 + * @param 字段值的类型 + * @param selectedColumn 字段名 + * @param clazz Entity类 + * @param flipper 翻页对象 + * @param bean 过滤Bean + * @return 字段集合 */ @Override public Sheet queryColumnSheet(final String selectedColumn, Class clazz, final Flipper flipper, final FilterBean bean) { @@ -1459,11 +1464,11 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param column - * @param key - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param column 过滤字段名 + * @param key 过滤字段值 + * @return Entity对象的集合 */ @Override public List queryList(final Class clazz, final String column, final Serializable key) { @@ -1479,10 +1484,10 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param bean - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param bean 过滤Bean + * @return Entity对象集合 */ @Override public List queryList(final Class clazz, final FilterBean bean) { @@ -1510,11 +1515,11 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param selects - * @param bean - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param selects 收集的字段 + * @param bean 过滤Bean + * @return Entity对象的集合 */ @Override public List queryList(final Class clazz, final SelectColumn selects, final FilterBean bean) { @@ -1600,11 +1605,11 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param flipper - * @param bean - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param flipper 翻页对象 + * @param bean 过滤Bean + * @return Entity对象的集合 */ @Override public Sheet querySheet(final Class clazz, final Flipper flipper, final FilterBean bean) { @@ -1632,12 +1637,12 @@ public final class DataDefaultSource implements DataSource, Function - * @param clazz - * @param selects - * @param flipper - * @param bean - * @return + * @param Entity类的泛型 + * @param clazz Entity类 + * @param selects 收集的字段集合 + * @param flipper 翻页对象 + * @param bean 过滤Bean + * @return Entity对象的集合 */ @Override public Sheet querySheet(final Class clazz, final SelectColumn selects, final Flipper flipper, final FilterBean bean) { diff --git a/src/org/redkale/source/DataSQLListener.java b/src/org/redkale/source/DataSQLListener.java index 7df22aad0..0d5295a5a 100644 --- a/src/org/redkale/source/DataSQLListener.java +++ b/src/org/redkale/source/DataSQLListener.java @@ -6,7 +6,7 @@ package org.redkale.source; /** - * @Resource(name = "property.datasource.nodeid") + * @Resource(name = "property.datasource.nodeid") * *

详情见: http://www.redkale.org * @author zhangjx diff --git a/src/org/redkale/source/DataSource.java b/src/org/redkale/source/DataSource.java index 7b6a14b00..a48c6ae5c 100644 --- a/src/org/redkale/source/DataSource.java +++ b/src/org/redkale/source/DataSource.java @@ -12,7 +12,9 @@ import org.redkale.util.*; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ @SuppressWarnings("unchecked") @@ -22,8 +24,8 @@ public interface DataSource { /** * 新增对象, 必须是Entity对象 * - * @param - * @param values + * @param 泛型 + * @param values Entity对象 */ public void insert(final T... values); @@ -34,11 +36,19 @@ public interface DataSource { /** * 删除对象, 必须是Entity对象 * - * @param - * @param values + * @param 泛型 + * @param values Entity对象 */ public void delete(final T... values); + /** + * 根据主键值删除数据 + * 等价SQL: DELETE FROM WHERE {primary} IN {ids} + * + * @param Entity类的泛型 + * @param clazz Entity类 + * @param ids 主键值 + */ public void delete(final Class clazz, final Serializable... ids); public void delete(final Class clazz, final FilterNode node); @@ -54,8 +64,8 @@ public interface DataSource { /** * 更新对象, 必须是Entity对象 * - * @param - * @param values + * @param 泛型 + * @param values Entity对象 */ public void update(final T... values); @@ -112,10 +122,10 @@ public interface DataSource { /** * 根据主键获取对象 * - * @param - * @param clazz - * @param pk - * @return + * @param 泛型 + * @param clazz Entity类 + * @param pk 主键值 + * @return Entity对象 */ public T find(final Class clazz, final Serializable pk); @@ -162,13 +172,13 @@ public interface DataSource { /** * 根据指定字段值查询对象某个字段的集合 * - * @param - * @param - * @param selectedColumn - * @param clazz - * @param column - * @param key - * @return + * @param Entity泛型 + * @param 字段类型 + * @param selectedColumn 字段名 + * @param clazz Entity类 + * @param column 过滤字段名 + * @param key 过滤字段值 + * @return 字段值的集合 */ public HashSet queryColumnSet(final String selectedColumn, final Class clazz, final String column, final Serializable key); @@ -197,14 +207,14 @@ public interface DataSource { /** * 根据指定参数查询对象某个字段的集合 - *

- * @param - * @param - * @param selectedColumn - * @param clazz - * @param flipper - * @param bean - * @return + * + * @param Entity泛型 + * @param 字段类型 + * @param selectedColumn 字段名 + * @param clazz Entity类 + * @param flipper 翻页对象 + * @param bean 过滤Bean + * @return 结果集合 */ public Sheet queryColumnSheet(final String selectedColumn, final Class clazz, final Flipper flipper, final FilterBean bean); @@ -218,11 +228,11 @@ public interface DataSource { /** * 根据指定字段值查询对象集合 * - * @param - * @param clazz - * @param column - * @param key - * @return + * @param Entity泛型 + * @param clazz Entity类 + * @param column 过滤字段名 + * @param key 过滤字段值 + * @return Entity的List */ public List queryList(final Class clazz, final String column, final Serializable key); @@ -269,11 +279,11 @@ public interface DataSource { /** * 根据指定参数查询对象某个对象的集合页 *

- * @param - * @param clazz - * @param flipper - * @param bean - * @return + * @param Entity泛型 + * @param clazz Entity类 + * @param flipper 翻页对象 + * @param bean 过滤Bean + * @return Entity的Sheet */ public Sheet querySheet(final Class clazz, final Flipper flipper, final FilterBean bean); diff --git a/src/org/redkale/source/DistributeGenerator.java b/src/org/redkale/source/DistributeGenerator.java index 7bb0f6ad4..849767df0 100644 --- a/src/org/redkale/source/DistributeGenerator.java +++ b/src/org/redkale/source/DistributeGenerator.java @@ -22,8 +22,8 @@ public @interface DistributeGenerator { /** * 如果allocationSize的值小于或等于1,则主键不会加上nodeid - *

- * @return + * + * @return allocationSize */ int allocationSize() default 1000; } diff --git a/src/org/redkale/source/EntityCache.java b/src/org/redkale/source/EntityCache.java index 00941ead4..b1703c3fe 100644 --- a/src/org/redkale/source/EntityCache.java +++ b/src/org/redkale/source/EntityCache.java @@ -18,9 +18,11 @@ import org.redkale.util.*; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param + * @param Entity类的泛型 */ public final class EntityCache { diff --git a/src/org/redkale/source/EntityInfo.java b/src/org/redkale/source/EntityInfo.java index c61dc87d2..21cd6260f 100644 --- a/src/org/redkale/source/EntityInfo.java +++ b/src/org/redkale/source/EntityInfo.java @@ -19,9 +19,11 @@ import org.redkale.util.*; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx - * @param + * @param Entity类的泛型 */ @SuppressWarnings("unchecked") public final class EntityInfo { @@ -266,8 +268,8 @@ public final class EntityInfo { /** * 是否虚拟类 - *

- * @return + * + * @return 是否虚拟类 */ public boolean isVirtualEntity() { return table == null; diff --git a/src/org/redkale/source/FilterColumn.java b/src/org/redkale/source/FilterColumn.java index b2140229a..dd6de780b 100644 --- a/src/org/redkale/source/FilterColumn.java +++ b/src/org/redkale/source/FilterColumn.java @@ -11,7 +11,9 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ @Inherited @@ -23,24 +25,24 @@ public @interface FilterColumn { /** * 对应Entity Class中字段的名称, 而不是SQL字段名称 * - * @return + * @return 字段名 */ String name() default ""; /** - * 当字段类型是Number时, 如果值>=least() 则需要过滤, 否则跳过该字段 + * 当字段类型是Number时, 如果值>=least() 则需要过滤, 否则跳过该字段 * - * @return + * @return 最小可过滤值 */ long least() default 1; /** * express的默认值根据字段类型的不同而不同: - * 数组 --> IN - * Range --> Between - * 其他 --> = + * 数组 --> IN + * Range --> Between + * 其他 --> = * - * @return + * @return 字段表达式 */ FilterExpress express() default FilterExpress.EQUAL; diff --git a/src/org/redkale/source/FilterJoinColumn.java b/src/org/redkale/source/FilterJoinColumn.java index 729b476ac..9cd57bc9e 100644 --- a/src/org/redkale/source/FilterJoinColumn.java +++ b/src/org/redkale/source/FilterJoinColumn.java @@ -11,7 +11,9 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; /** * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ @Inherited @@ -23,7 +25,7 @@ public @interface FilterJoinColumn { /** * 关联表 通常join表默认别名为b/c/d/...自增, 被join表默认别名为a * - * @return + * @return 关联表 */ Class table(); @@ -31,9 +33,9 @@ public @interface FilterJoinColumn { * * 多个关联字段, 默认使用join表(b)的主键, join表与被join表(a)的字段必须一样 * 例如: SELECT a.* FROM user a INNER JOIN record b ON a.userid = b.userid AND a.usertype = b.usertype - * 那么注解为: @FilterJoinColumn(table = Record.class, columns = {"userid", "usertype"}) - *

- * @return + * 那么注解为: @FilterJoinColumn(table = Record.class, columns = {"userid", "usertype"}) + * + * @return 关联字段 */ String[] columns(); } diff --git a/src/org/redkale/source/FilterNode.java b/src/org/redkale/source/FilterNode.java index a6afab1e9..b2d5df42b 100644 --- a/src/org/redkale/source/FilterNode.java +++ b/src/org/redkale/source/FilterNode.java @@ -17,7 +17,9 @@ import org.redkale.util.*; * 在调用 createSQLExpress 之前必须先调用 createSQLJoin * 在调用 createPredicate 之前必须先调用 isCacheUseable * - *

详情见: http://www.redkale.org + *

+ * 详情见: http://www.redkale.org + * * @author zhangjx */ public class FilterNode { @@ -112,11 +114,11 @@ public class FilterNode { /** * 该方法需要重载 * - * @param - * @param func - * @param joinTabalis - * @param info - * @return + * @param Entity类的泛型 + * @param func EntityInfo的加载器 + * @param joinTabalis 关联表集合 + * @param info Entity类的EntityInfo + * @return SQL的join语句 不存在返回null */ protected CharSequence createSQLJoin(final Function func, final Map joinTabalis, final EntityInfo info) { if (joinTabalis == null || this.nodes == null) return null; @@ -133,7 +135,7 @@ public class FilterNode { /** * 该方法需要重载 * - * @return + * @return 是否存在关联表 */ protected boolean isjoin() { if (this.nodes == null) return false; @@ -160,8 +162,8 @@ public class FilterNode { /** * 该方法需要重载 * - * @param entityApplyer - * @return + * @param entityApplyer EntityInfo的加载器 + * @return 是否可以使用缓存 */ protected boolean isCacheUseable(final Function entityApplyer) { if (this.nodes == null) return true; @@ -174,10 +176,10 @@ public class FilterNode { /** * 该方法需要重载 * - * @param - * @param joinTabalis - * @param info - * @return + * @param Entity类的泛型 + * @param joinTabalis 关联表的集合 + * @param info EntityInfo + * @return JOIN的SQL语句 */ protected CharSequence createSQLExpress(final EntityInfo info, final Map joinTabalis) { CharSequence sb0 = this.column == null || info == null ? null : createElementSQLExpress(info, joinTabalis == null ? null : joinTabalis.get(info.getType())); diff --git a/src/org/redkale/source/Range.java b/src/org/redkale/source/Range.java index e4806022b..7205aedd2 100644 --- a/src/org/redkale/source/Range.java +++ b/src/org/redkale/source/Range.java @@ -13,7 +13,7 @@ import java.util.function.*; * 详情见: http://www.redkale.org * * @author zhangjx - * @param + * @param Comparable的子类型 */ public interface Range extends java.io.Serializable, Predicate {