fanruan
/
easyexcel
mirror of https://github.com/alibaba/easyexcel
3
0
Fork 1
Code Issues Releases Wiki Activity
Browse Source

Merge pull request #2928 from alibaba/bugfix 

修改javadoc报错
pull/2550/merge v3.2.0
Jiaju Zhuang 2 years ago committed by GitHub
parent
52195c957c eadebfe67d
commit
17bd0f26d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 46 additions and 97 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 123
      easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java
  2. 10
      easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java
  3. 2
      easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java
  4. 8
      easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java

123
easyexcel-core/src/main/java/com/alibaba/excel/EasyExcelFactory.java
Unescape View File

@ -14,25 +14,10 @@ import com.alibaba.excel.write.builder.ExcelWriterTableBuilder;
/**
* Reader and writer factory class
*
* <h1>Quick start</h1>
* <h2>Read</h2>
* <h3>Sample1</h3>
*
* <h3>Sample2</h3>
*
* <h2>Write</h2>
*
* <h3>Sample1</h3>
*
* <h3>Sample2</h3>
*
*
*
* @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 <code>writerSheet</code>
*
* @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) {

10
easyexcel-core/src/main/java/com/alibaba/excel/enums/ReadDefaultReturnEnum.java
Unescape View File

@ -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:
* <ol>
* <li>{@link BigDecimal}<li/>
* <li>{@link Boolean}<li/>
* <li>{@link String}<li/>
* <li>{@link LocalDateTime}<li/>
* <ol/>
* <li>{@link BigDecimal}</li>
* <li>{@link Boolean}</li>
* <li>{@link String}</li>
* <li>{@link LocalDateTime}</li>
* </ol>
*/
ACTUAL_DATA,

2
easyexcel-core/src/main/java/com/alibaba/excel/metadata/data/ReadCellData.java
Unescape View File

@ -40,7 +40,7 @@ public class ReadCellData<T> extends CellData<T> {
* 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`
* </li>
* <ol/>
* </ol>
* {@link CellDataTypeEnum#NUMBER} {@link CellDataTypeEnum#DATE}
*/
private BigDecimal originalNumberValue;

8
easyexcel-core/src/main/java/com/alibaba/excel/write/metadata/RowData.java
Unescape View File

@ -18,17 +18,17 @@ public interface RowData {
/**
* Returns the number of elements in this collection. If this collection
* contains more than <tt>Integer.MAX_VALUE</tt> elements, returns
* <tt>Integer.MAX_VALUE</tt>.
* contains more than <code>Integer.MAX_VALUE</code> elements, returns
* <code>Integer.MAX_VALUE</code>.
*
* @return the number of elements in this collection
*/
int size();
/**
* Returns <tt>true</tt> if this collection contains no elements.
* Returns <code>true</code> if this collection contains no elements.
*
* @return <tt>true</tt> if this collection contains no elements
* @return <code>true</code> if this collection contains no elements
*/
boolean isEmpty();

Write Preview
Loading…
Cancel
Save