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 * - *
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:
* 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();