瀏覽代碼

Java Doc更新

xueli.xue 8 年之前
父節點
當前提交
6b0d17a4c6

+ 3 - 2
xxl-job-core/src/main/java/com/xxl/job/core/glue/loader/GlueLoader.java 查看文件

@@ -8,8 +8,9 @@ public interface GlueLoader {
8 8
 
9 9
 	/**
10 10
 	 * load code source by name, ensure every load is the latest.
11
-	 * @param name
12
-	 * @return
11
+	 * @param job_group
12
+	 * @param job_name
13
+	 * @return code source
13 14
 	 */
14 15
 	public String load(String job_group, String job_name);
15 16
 	

+ 1 - 1
xxl-job-core/src/main/java/com/xxl/job/core/handler/IJobHandler.java 查看文件

@@ -12,7 +12,7 @@ public abstract class IJobHandler extends HandlerRouter {
12 12
 	 * job handler <br><br>
13 13
 	 * the return Object will be and stored
14 14
 	 * @param params
15
-	 * @return 
15
+	 * @return job status
16 16
 	 * @throws Exception
17 17
 	 */
18 18
 	public abstract JobHandleStatus execute(String... params) throws Exception;

+ 4 - 4
xxl-job-core/src/main/java/com/xxl/job/core/log/XxlJobFileAppender.java 查看文件

@@ -103,7 +103,7 @@ public class XxlJobFileAppender extends AppenderSkeleton {
103 103
 	 * support read log-file
104 104
 	 * @param triggerDate
105 105
 	 * @param trigger_log_id
106
-	 * @return
106
+	 * @return log content
107 107
 	 */
108 108
 	public static String readLog(Date triggerDate, int trigger_log_id ){
109 109
 		if (triggerDate==null || trigger_log_id<=0) {
@@ -137,7 +137,7 @@ public class XxlJobFileAppender extends AppenderSkeleton {
137 137
 	/**
138 138
 	 * read log data
139 139
 	 * @param logFile
140
-	 * @return
140
+	 * @return log line content
141 141
 	 */
142 142
 	public static String readLines(File logFile){
143 143
 		BufferedReader reader = null;
@@ -167,9 +167,9 @@ public class XxlJobFileAppender extends AppenderSkeleton {
167 167
 	
168 168
 	/**
169 169
 	 * read data from line num
170
-	 * @param sourceFile
170
+	 * @param logFile
171 171
 	 * @param fromLineNum
172
-	 * @return
172
+	 * @return log content
173 173
 	 * @throws Exception
174 174
 	 */
175 175
 	public static String readLinesFrom(File logFile, int fromLineNum) {  

+ 1 - 1
xxl-job-core/src/main/java/com/xxl/job/core/router/HandlerRouter.java 查看文件

@@ -64,7 +64,7 @@ public class HandlerRouter {
64 64
 		/**
65 65
 		 * match Action by enum name
66 66
 		 * @param name
67
-         * @return
67
+         * @return action
68 68
          */
69 69
 		public static IAction matchAction(String name){
70 70
 			if (name!=null && name.trim().length()>0) {

+ 1 - 1
xxl-job-core/src/main/java/com/xxl/job/core/util/ByteHexConverter.java 查看文件

@@ -51,7 +51,7 @@ public class ByteHexConverter {
51 51
 	/**
52 52
 	 * get length of string
53 53
 	 * @param str
54
-	 * @return
54
+	 * @return len of string byte
55 55
 	 */
56 56
 	public static int getByteLen(String str){
57 57
 		if (str==null || str.length()==0) {

+ 4 - 4
xxl-job-core/src/main/java/com/xxl/job/core/util/IpUtil.java 查看文件

@@ -1,13 +1,13 @@
1 1
 package com.xxl.job.core.util;
2 2
 
3
+import org.slf4j.Logger;
4
+import org.slf4j.LoggerFactory;
5
+
3 6
 import java.net.InetAddress;
4 7
 import java.net.NetworkInterface;
5 8
 import java.net.UnknownHostException;
6 9
 import java.util.Enumeration;
7 10
 
8
-import org.slf4j.Logger;
9
-import org.slf4j.LoggerFactory;
10
-
11 11
 /**
12 12
  * get ip
13 13
  * @author xuxueli 2016-5-22 11:38:05
@@ -17,7 +17,7 @@ public class IpUtil {
17 17
 
18 18
 	/**
19 19
 	 * 获取本机ip
20
-	 * @return
20
+	 * @return ip
21 21
 	 */
22 22
 	public static String getIp() {
23 23
 		try {

+ 6 - 6
xxl-job-core/src/main/java/com/xxl/job/core/util/JacksonUtil.java 查看文件

@@ -1,16 +1,16 @@
1 1
 package com.xxl.job.core.util;
2 2
 
3 3
 
4
-import java.io.IOException;
5
-import java.util.HashMap;
6
-import java.util.Map;
7
-
8 4
 import org.codehaus.jackson.JsonGenerationException;
9 5
 import org.codehaus.jackson.JsonParseException;
10 6
 import org.codehaus.jackson.map.JsonMappingException;
11 7
 import org.codehaus.jackson.map.ObjectMapper;
12 8
 import org.codehaus.jackson.type.TypeReference;
13 9
 
10
+import java.io.IOException;
11
+import java.util.HashMap;
12
+import java.util.Map;
13
+
14 14
 /**
15 15
  * Jackson util
16 16
  * 
@@ -29,7 +29,7 @@ public class JacksonUtil {
29 29
      * bean、array、List、Map --> json
30 30
      * 
31 31
      * @param obj
32
-     * @return
32
+     * @return json string
33 33
      * @throws Exception
34 34
      */
35 35
     public static String writeValueAsString(Object obj) {
@@ -50,7 +50,7 @@ public class JacksonUtil {
50 50
      * 
51 51
      * @param jsonStr
52 52
      * @param clazz
53
-     * @return
53
+     * @return obj
54 54
      * @throws Exception
55 55
      */
56 56
     public static <T> T readValue(String jsonStr, Class<T> clazz) {

+ 3 - 3
xxl-job-core/src/main/java/com/xxl/job/core/util/XxlJobNetCommUtil.java 查看文件

@@ -34,7 +34,7 @@ public class XxlJobNetCommUtil {
34 34
     /**
35 35
      * format object to hex-json
36 36
      * @param obj
37
-     * @return
37
+     * @return result
38 38
      */
39 39
     public static String formatObj2HexJson(Object obj){
40 40
     	// obj to json
@@ -56,7 +56,7 @@ public class XxlJobNetCommUtil {
56 56
      * parse hex-json to object
57 57
      * @param hex
58 58
      * @param clazz
59
-     * @return
59
+     * @return result
60 60
      */
61 61
     public static <T> T parseHexJson2Obj(String hex, Class<T> clazz){
62 62
     	// hex to byte[]
@@ -161,7 +161,7 @@ public class XxlJobNetCommUtil {
161 161
 	/**
162 162
 	 * parse address ip:port to url http://.../ 
163 163
 	 * @param address
164
-	 * @return
164
+	 * @return result
165 165
 	 */
166 166
 	public static String addressToUrl(String address){
167 167
 		return "http://" + address + "/";