KERNEL-1117 增加了java文档说明，补充IOKit的测试用例

5 years ago · 62dbb7f9e8
5 changed files with 57 additions and 35 deletions
--- a/src/main/java/com/fanruan/api/design/util/GUICoreKit.java
+++ b/src/main/java/com/fanruan/api/design/util/GUICoreKit.java
@ -13,10 +13,10 @@ public class GUICoreKit {

    /**
     * 弹出菜单，在坐标为x,y处弹出内容为component的菜单
-     * @param menu
-     * @param component
-     * @param x
-     * @param y
+     * @param menu 目录框
+     * @param component 目录内组件
+     * @param x 横坐标
+     * @param y 纵坐标
     */
    public static void showPopupMenu(JPopupMenu menu, Component component, int x, int y) {
        GUICoreUtils.showPopupMenu(menu, component, x, y);
--- a/src/main/java/com/fanruan/api/util/ArrayKit.java
+++ b/src/main/java/com/fanruan/api/util/ArrayKit.java
@ -85,8 +85,7 @@ public class ArrayKit {

    /**
     * 判断数组是否为不空
-     * @param array
-     * @param <T>
+     * @param array 原数组
     * @return 若数组array不空返回true，否则返回false
     */
    public static <T> boolean isNotEmpty(T[] array) {
--- a/src/main/java/com/fanruan/api/util/GeneralKit.java
+++ b/src/main/java/com/fanruan/api/util/GeneralKit.java
@ -61,8 +61,8 @@ public class GeneralKit {

    /**
     * 返回两个对象比较的大小
-     * @param obj1
-     * @param obj2
+     * @param obj1 源对象
+     * @param obj2 待比较对象
     * @return 若相等返回0，obj1小于obj2返回负数，否则返回正数
     */
    public static int compare(Object obj1, Object obj2) {
--- a/src/main/java/com/fanruan/api/util/StringKit.java
+++ b/src/main/java/com/fanruan/api/util/StringKit.java
@ -106,8 +106,8 @@ public class StringKit {
    }
    /**
     * 获取text字符串中去除结尾suffix字符串的部分
-     * @param text
-     * @param suffix
+     * @param text 源字符串
+     * @param suffix 后缀字符串
     * @return 若text字符串结尾是suffix，则返回去除suffix的部分，否则返回text
     */
    public static String cutStringEndWith(String text, String suffix) {
@ -116,8 +116,8 @@ public class StringKit {

    /**获取text字符串去除开头startString部分
     *
-     * @param text
-     * @param startString
+     * @param text 源字符串
+     * @param startString 前缀字符串
     * @return 若text字符串开头是suffix，则返回去除startString部分否则返回text
     */
    public static String cutStringStartWith(String text, String startString) {
@ -126,7 +126,7 @@ public class StringKit {

    /**
     * 去掉text字符串两边的空格或ASCII码小于空格的字符
-     * @param text
+     * @param text 源字符串
     * @return 若text只含空格字符，或ASCII码小于空格的字符，返回null，否则返回去除两边空字符后的text
     */
    public static String trimToNull(String text) {
@ -135,8 +135,8 @@ public class StringKit {

    /**
     * 令text以startString开头
-     * @param text
-     * @param startString
+     * @param text 源字符串
+     * @param startString 前缀字符串
     * @return 若text不以startString开头，在text前添加startString。若text以startString开头返回text
     */
    public static String perfectStart(String text, String startString) {
@ -145,8 +145,8 @@ public class StringKit {

    /**
     * 令text以suffix结尾
-     * @param text
-     * @param suffix
+     * @param text 源字符串
+     * @param suffix 前缀字符串
     * @return 若text不以suffix结尾，在text后添加suffix。若text以suffix结尾返回text
     */
    public static String perfectEnd(String text, String suffix) {
@ -165,7 +165,7 @@ public class StringKit {

    /**
     * 返回text长度
-     * @param text
+     * @param text 源字符串
     * @return 若text为null返回0，否则返回text长度
     */
    public static int getLength(String text) {
@ -174,9 +174,9 @@ public class StringKit {

    /**
     * 判断text1和text2在去掉开头或结尾的ignoreStr部分是否相等
-     * @param text1
-     * @param text2
-     * @param ignoreStr
+     * @param text1 源字符串
+     * @param text2 待比较字符串
+     * @param ignoreStr 可以忽略的字符串
     * @return 如果text1和txet2去掉开头结尾的ignoreStr后相等返回true，不等返回false
     */
    public static boolean equalsIgnore(String text1, String text2, String ignoreStr) {
@ -185,8 +185,8 @@ public class StringKit {

    /**
     * 将str加入到strArr字符串数组的每个字符串后方（不包括最后一个字符串），同时将结果字符串数组连接起来，形成新的字符串
-     * @param str
-     * @param strArr
+     * @param str 源字符串
+     * @param strArr 待连接字符串数组
     * @return 若strArr为空则返回null，若strArr长度为0返回""空字符串，否则返回连接后的字符串
     */
    public static String join(String str, String[] strArr) {
@ -195,7 +195,7 @@ public class StringKit {

    /**
     * 将text字符串中的A-J转换成0-9,工具函数
-     * @param text
+     * @param text 源字符串
     * @return 返回转换后的字符串
     */
    public static String parseVersion(String text) {
@ -204,7 +204,7 @@ public class StringKit {

    /**
     * 判断text是否是json中数组的string形式
-     * @param text
+     * @param text 源字符串
     * @return 若是数组的String形式返回true，否则返回flase
     */
    public static boolean isArrayType(String text) {
@ -213,7 +213,7 @@ public class StringKit {

    /**
     *从原本json数组类型的String取出其中的每一个用逗号间隔元素，作为String二维数组返回值
-     * @param text
+     * @param text 源字符串
     * @return 取出text中用逗号间隔的元素
     */
    public static String[][] stringToArray(String text) {
@ -222,9 +222,9 @@ public class StringKit {

    /**
     *对text中每个字符，用charsetName为名的编码方式解码后，返回解码后字节长度从0到bytelength的部分，以String形式返回
-     * @param text
-     * @param charsetName
-     * @param byteLength
+     * @param text 源字符串
+     * @param charsetName 编码方式
+     * @param byteLength 字节长度
     * @return 若text为空或byteLength小于等于0返回空字符串，否则以String形式返回解码后字节长度从0到bytelength的部分
     */
    public static String subStringByByteLength(String text, String charsetName, int byteLength) throws UnsupportedEncodingException {
@ -233,8 +233,8 @@ public class StringKit {

    /**
     * 比较text和compareStr两字符串值是否相等
-     * @param text
-     * @param compareStr
+     * @param text 源字符串
+     * @param compareStr 待比较字符串
     * @return 若text和compareStr两字符串的值相同返回true，否则返回false
     */
    public static boolean equals(String text, String compareStr) {
@ -243,8 +243,8 @@ public class StringKit {

    /**
     * 比较text和compareStr两字符串忽略大小写的情况下值是否相等
-     * @param text
-     * @param compareStr
+     * @param text 源字符串
+     * @param compareStr 待比较字符串
     * @return 在忽略大小写的情况下，若text和compareStr两字符串的值相同返回true，否则返回false
     */
    public static boolean equalsIgnoreCase(String text, String compareStr) {
@ -253,8 +253,8 @@ public class StringKit {

    /**
     * 扩展text的长度至stringLength，不足则以空格填充
-     * @param text
-     * @param stringLength
+     * @param text 源字符串
+     * @param stringLength 字符串扩展长度
     * @return 若text长度比stringLength，则将text扩充到stringLength长度，否则返回text
     */
    public static String rightPad(String text, int stringLength) {
--- a/src/test/java/com/fanruan/api/util/IOKitTest.java
+++ b/src/test/java/com/fanruan/api/util/IOKitTest.java
@ -5,6 +5,9 @@ import org.junit.Assert;
 import org.junit.Test;
 import sun.nio.cs.ext.GBK;

+import com.fr.general.IOUtils;
+import javax.swing.*;
+import java.io.InputStream;
 import java.nio.charset.StandardCharsets;

 /**
@ -24,4 +27,24 @@ public class IOKitTest extends Prepare {
        String text = IOKit.readResourceAsString("/com/fanruan/api/util/iokit.txt");
        Assert.assertEquals("Hello World!", text);
    }
+
+    @Test
+    public void readIcon() {
+        Assert.assertEquals((IOKit.readIcon("/com/fanruan/api/util/close.png")).getIconHeight(),(new ImageIcon(IOUtils.readImageWithCache("/com/fanruan/api/util/close.png")).getIconHeight()));
+    }
+
+    @Test
+    public void readResource() {
+        try {
+            InputStream in = IOKit.readResource("/com/fanruan/api/util/iokit.txt");
+            StringBuffer out = new StringBuffer();
+            byte[] b = new byte[4096];
+            for (int n; (n = in.read(b)) != -1; ) {
+                out.append(new String(b, 0, n));
+            }
+            Assert.assertEquals("Hello World!", out.toString());
+        } catch (Exception e) {
+
+        }
+    }
 }