From eadebfe67d505a845bad3438ae7040b3ffebc48a Mon Sep 17 00:00:00 2001 From: Jiaju Zhuang Date: Wed, 18 Jan 2023 23:47:55 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9javadoc=E6=8A=A5=E9=94=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/alibaba/excel/EasyExcelFactory.java | 123 +++++------------- .../excel/enums/ReadDefaultReturnEnum.java | 10 +- .../excel/metadata/data/ReadCellData.java | 2 +- .../alibaba/excel/write/metadata/RowData.java | 8 +- 4 files changed, 46 insertions(+), 97 deletions(-) diff --git a/easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java b/easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java index ef9b3ac3..80c40851 100644 --- a/easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java +++ b/easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java @@ -14,25 +14,10 @@ import com.alibaba.excel.write.builder.ExcelWriterTableBuilder; /** * Reader and writer factory class * - *

Quick start

- *

Read

- *

Sample1

- * - *

Sample2

- * - *

Write

- * - *

Sample1

- * - *

Sample2

- * - * - * * @author jipengfei */ public class EasyExcelFactory { - /** * Build excel the write * @@ -45,8 +30,7 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param file - * File to write + * @param file File to write * @return Excel writer builder */ public static ExcelWriterBuilder write(File file) { @@ -56,10 +40,8 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param file - * File to write - * @param head - * Annotate the class for configuration information + * @param file File to write + * @param head Annotate the class for configuration information * @return Excel writer builder */ public static ExcelWriterBuilder write(File file, Class head) { @@ -74,8 +56,7 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param pathName - * File path to write + * @param pathName File path to write * @return Excel writer builder */ public static ExcelWriterBuilder write(String pathName) { @@ -85,10 +66,8 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param pathName - * File path to write - * @param head - * Annotate the class for configuration information + * @param pathName File path to write + * @param head Annotate the class for configuration information * @return Excel writer builder */ public static ExcelWriterBuilder write(String pathName, Class head) { @@ -103,8 +82,7 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param outputStream - * Output stream to write + * @param outputStream Output stream to write * @return Excel writer builder */ public static ExcelWriterBuilder write(OutputStream outputStream) { @@ -114,10 +92,8 @@ public class EasyExcelFactory { /** * Build excel the write * - * @param outputStream - * Output stream to write - * @param head - * Annotate the class for configuration information. + * @param outputStream Output stream to write + * @param head Annotate the class for configuration information. * @return Excel writer builder */ public static ExcelWriterBuilder write(OutputStream outputStream, Class head) { @@ -141,8 +117,7 @@ public class EasyExcelFactory { /** * Build excel the writerSheet * - * @param sheetNo - * Index of sheet,0 base. + * @param sheetNo Index of sheet,0 base. * @return Excel sheet writer builder. */ public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo) { @@ -152,8 +127,7 @@ public class EasyExcelFactory { /** * Build excel the 'writerSheet' * - * @param sheetName - * The name of sheet. + * @param sheetName The name of sheet. * @return Excel sheet writer builder. */ public static ExcelWriterSheetBuilder writerSheet(String sheetName) { @@ -163,10 +137,8 @@ public class EasyExcelFactory { /** * Build excel the 'writerSheet' * - * @param sheetNo - * Index of sheet,0 base. - * @param sheetName - * The name of sheet. + * @param sheetNo Index of sheet,0 base. + * @param sheetName The name of sheet. * @return Excel sheet writer builder. */ public static ExcelWriterSheetBuilder writerSheet(Integer sheetNo, String sheetName) { @@ -192,8 +164,7 @@ public class EasyExcelFactory { /** * Build excel the 'writerTable' * - * @param tableNo - * Index of table,0 base. + * @param tableNo Index of table,0 base. * @return Excel table writer builder. */ public static ExcelWriterTableBuilder writerTable(Integer tableNo) { @@ -216,8 +187,7 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param file - * File to read. + * @param file File to read. * @return Excel reader builder. */ public static ExcelReaderBuilder read(File file) { @@ -227,10 +197,8 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param file - * File to read. - * @param readListener - * Read listener. + * @param file File to read. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(File file, ReadListener readListener) { @@ -240,12 +208,9 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param file - * File to read. - * @param head - * Annotate the class for configuration information. - * @param readListener - * Read listener. + * @param file File to read. + * @param head Annotate the class for configuration information. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(File file, Class head, ReadListener readListener) { @@ -263,8 +228,7 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param pathName - * File path to read. + * @param pathName File path to read. * @return Excel reader builder. */ public static ExcelReaderBuilder read(String pathName) { @@ -274,10 +238,8 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param pathName - * File path to read. - * @param readListener - * Read listener. + * @param pathName File path to read. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(String pathName, ReadListener readListener) { @@ -287,12 +249,9 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param pathName - * File path to read. - * @param head - * Annotate the class for configuration information. - * @param readListener - * Read listener. + * @param pathName File path to read. + * @param head Annotate the class for configuration information. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(String pathName, Class head, ReadListener readListener) { @@ -310,8 +269,7 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param inputStream - * Input stream to read. + * @param inputStream Input stream to read. * @return Excel reader builder. */ public static ExcelReaderBuilder read(InputStream inputStream) { @@ -321,10 +279,8 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param inputStream - * Input stream to read. - * @param readListener - * Read listener. + * @param inputStream Input stream to read. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(InputStream inputStream, ReadListener readListener) { @@ -334,12 +290,9 @@ public class EasyExcelFactory { /** * Build excel the read * - * @param inputStream - * Input stream to read. - * @param head - * Annotate the class for configuration information. - * @param readListener - * Read listener. + * @param inputStream Input stream to read. + * @param head Annotate the class for configuration information. + * @param readListener Read listener. * @return Excel reader builder. */ public static ExcelReaderBuilder read(InputStream inputStream, Class head, ReadListener readListener) { @@ -366,8 +319,7 @@ public class EasyExcelFactory { /** * Build excel the 'readSheet' * - * @param sheetNo - * Index of sheet,0 base. + * @param sheetNo Index of sheet,0 base. * @return Excel sheet reader builder. */ public static ExcelReaderSheetBuilder readSheet(Integer sheetNo) { @@ -377,8 +329,7 @@ public class EasyExcelFactory { /** * Build excel the 'readSheet' * - * @param sheetName - * The name of sheet. + * @param sheetName The name of sheet. * @return Excel sheet reader builder. */ public static ExcelReaderSheetBuilder readSheet(String sheetName) { @@ -388,10 +339,8 @@ public class EasyExcelFactory { /** * Build excel the 'readSheet' * - * @param sheetNo - * Index of sheet,0 base. - * @param sheetName - * The name of sheet. + * @param sheetNo Index of sheet,0 base. + * @param sheetName The name of sheet. * @return Excel sheet reader builder. */ public static ExcelReaderSheetBuilder readSheet(Integer sheetNo, String sheetName) { diff --git a/easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java b/easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java index c0340d83..4c2a317f 100644 --- a/easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java +++ b/easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java @@ -23,11 +23,11 @@ public enum ReadDefaultReturnEnum { * Returns the actual type. * Will be automatically selected according to the cell contents what return type, will return the following class: *
    - *
  1. {@link BigDecimal}
  2. - *
  3. {@link Boolean}
  4. - *
  5. {@link String}
  6. - *
  7. {@link LocalDateTime}
  8. - *
      + *
    1. {@link BigDecimal}
      2. + *
    2. {@link Boolean}
      3. + *
    3. {@link String}
      4. + *
    4. {@link LocalDateTime}
      5. + *
    */ ACTUAL_DATA, diff --git a/easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java b/easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java index 9432e994..1d3a2a2f 100644 --- a/easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java +++ b/easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java @@ -40,7 +40,7 @@ public class ReadCellData extends CellData { * for example, originalNumberValue = `44729.99998836806` ,time is:`2022-06-17 23:59:58.995`, * But in excel is displayed:` 2022-06-17 23:59:59`, dateValue = `2022-06-17 23:59:59` *
    9. - *
      + *
    * {@link CellDataTypeEnum#NUMBER} {@link CellDataTypeEnum#DATE} */ private BigDecimal originalNumberValue; diff --git a/easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java b/easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java index cb86a3e0..b1fe86a3 100644 --- a/easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java +++ b/easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java @@ -18,17 +18,17 @@ public interface RowData { /** * Returns the number of elements in this collection. If this collection - * contains more than Integer.MAX_VALUE elements, returns - * Integer.MAX_VALUE. + * contains more than Integer.MAX_VALUE elements, returns + * Integer.MAX_VALUE. * * @return the number of elements in this collection */ int size(); /** - * Returns true if this collection contains no elements. + * Returns true if this collection contains no elements. * - * @return true if this collection contains no elements + * @return true if this collection contains no elements */ boolean isEmpty();