Browse Source

Merge pull request #1974 from lethal233/comment_typo_fix

fix typo in comments
developing
Jiaju Zhuang 3 years ago committed by GitHub
parent
commit
50ff4db89f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      src/main/java/com/alibaba/excel/annotation/ExcelProperty.java
  2. 2
      src/main/java/com/alibaba/excel/annotation/write/style/ContentFontStyle.java
  3. 2
      src/main/java/com/alibaba/excel/annotation/write/style/HeadFontStyle.java
  4. 8
      src/main/java/com/alibaba/excel/metadata/CellExtra.java
  5. 2
      src/main/java/com/alibaba/excel/metadata/property/FontProperty.java
  6. 8
      src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java
  7. 6
      src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java
  8. 6
      src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java
  9. 2
      src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java
  10. 4
      src/main/java/com/alibaba/excel/write/executor/AbstractExcelWriteExecutor.java
  11. 2
      src/main/java/com/alibaba/excel/write/executor/ExcelWriteAddExecutor.java
  12. 10
      src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java
  13. 4
      src/main/java/com/alibaba/excel/write/metadata/holder/WriteSheetHolder.java
  14. 8
      src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java
  15. 2
      src/main/java/com/alibaba/excel/write/metadata/style/WriteFont.java
  16. 2
      src/main/java/com/alibaba/excel/write/style/column/AbstractHeadColumnWidthStyleStrategy.java
  17. 4
      src/test/java/com/alibaba/easyexcel/test/core/compatibility/CompatibilityDataTest.java

2
src/main/java/com/alibaba/excel/annotation/ExcelProperty.java

@ -32,7 +32,7 @@ public @interface ExcelProperty {
/**
* Index of column
*
* Read or write it on the index of column,If it's equal to -1, it's sorted by Java class.
* Read or write it on the index of column, If it's equal to -1, it's sorted by Java class.
*
* priority: index > order > default sort
*

2
src/main/java/com/alibaba/excel/annotation/write/style/ContentFontStyle.java

@ -52,7 +52,7 @@ public @interface ContentFontStyle {
short color() default -1;
/**
* Set normal,super or subscript.
* Set normal, super or subscript.
*
* @see Font#SS_NONE
* @see Font#SS_SUPER

2
src/main/java/com/alibaba/excel/annotation/write/style/HeadFontStyle.java

@ -52,7 +52,7 @@ public @interface HeadFontStyle {
short color() default -1;
/**
* Set normal,super or subscript.
* Set normal, super or subscript.
*
* @see Font#SS_NONE
* @see Font#SS_SUPER

8
src/main/java/com/alibaba/excel/metadata/CellExtra.java

@ -20,19 +20,19 @@ public class CellExtra extends AbstractCell {
*/
private String text;
/**
* First row index,if this object is an interval
* First row index, if this object is an interval
*/
private Integer firstRowIndex;
/**
* Last row index,if this object is an interval
* Last row index, if this object is an interval
*/
private Integer lastRowIndex;
/**
* First column index,if this object is an interval
* First column index, if this object is an interval
*/
private Integer firstColumnIndex;
/**
* Last column index,if this object is an interval
* Last column index, if this object is an interval
*/
private Integer lastColumnIndex;

2
src/main/java/com/alibaba/excel/metadata/property/FontProperty.java

@ -40,7 +40,7 @@ public class FontProperty {
*/
private Short color;
/**
* Set normal,super or subscript.
* Set normal, super or subscript.
*
* @see Font#SS_NONE
* @see Font#SS_SUPER

8
src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java

@ -41,7 +41,7 @@ public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder<Exce
/**
* Read InputStream
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
public ExcelReaderBuilder file(InputStream inputStream) {
readWorkbook.setInputStream(inputStream);
@ -51,7 +51,7 @@ public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder<Exce
/**
* Read file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
public ExcelReaderBuilder file(File file) {
readWorkbook.setFile(file);
@ -61,7 +61,7 @@ public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder<Exce
/**
* Read file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
public ExcelReaderBuilder file(String pathName) {
return file(new File(pathName));
@ -70,7 +70,7 @@ public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder<Exce
/**
* Mandatory use 'inputStream' .Default is false.
* <p>
* if false,Will transfer 'inputStream' to temporary files to improve efficiency
* if false, Will transfer 'inputStream' to temporary files to improve efficiency
*/
public ExcelReaderBuilder mandatoryUseInputStream(Boolean mandatoryUseInputStream) {
readWorkbook.setMandatoryUseInputStream(mandatoryUseInputStream);

6
src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java

@ -27,19 +27,19 @@ public class ReadWorkbook extends ReadBasicParameter {
/**
* Read InputStream
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private InputStream inputStream;
/**
* Read file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private File file;
/**
* Mandatory use 'inputStream' .Default is false.
* <p>
* if false,Will transfer 'inputStream' to temporary files to improve efficiency
* if false, Will transfer 'inputStream' to temporary files to improve efficiency
*/
private Boolean mandatoryUseInputStream;
/**

6
src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java

@ -33,19 +33,19 @@ public class ReadWorkbookHolder extends AbstractReadHolder {
/**
* Read InputStream
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private InputStream inputStream;
/**
* Read file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private File file;
/**
* Mandatory use 'inputStream' .Default is false.
* <p>
* if false,Will transfer 'inputStream' to temporary files to improve efficiency
* if false, Will transfer 'inputStream' to temporary files to improve efficiency
*/
private Boolean mandatoryUseInputStream;
/**

2
src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java

@ -49,7 +49,7 @@ public class ExcelWriterBuilder extends AbstractExcelWriterParameterBuilder<Exce
}
/**
* Write excel in memory. Default false,the cache file is created and finally written to excel.
* Write excel in memory. Default false, the cache file is created and finally written to excel.
* <p>
* Comment and RichTextString are only supported in memory mode.
*/

4
src/main/java/com/alibaba/excel/write/executor/AbstractExcelWriteExecutor.java

@ -117,12 +117,12 @@ public abstract class AbstractExcelWriteExecutor implements ExcelWriteExecutor {
} catch (Exception e) {
throw new ExcelDataConvertException(cell.getRow().getRowNum(), cell.getColumnIndex(),
new CellData(CellDataTypeEnum.EMPTY), excelContentProperty,
"Convert data:" + value + " error,at row:" + cell.getRow().getRowNum(), e);
"Convert data:" + value + " error, at row:" + cell.getRow().getRowNum(), e);
}
if (cellData == null || cellData.getType() == null) {
throw new ExcelDataConvertException(cell.getRow().getRowNum(), cell.getColumnIndex(),
new CellData(CellDataTypeEnum.EMPTY), excelContentProperty,
"Convert data:" + value + " return null,at row:" + cell.getRow().getRowNum());
"Convert data:" + value + " return null, at row:" + cell.getRow().getRowNum());
}
return cellData;
}

2
src/main/java/com/alibaba/excel/write/executor/ExcelWriteAddExecutor.java

@ -48,7 +48,7 @@ public class ExcelWriteAddExecutor extends AbstractExcelWriteExecutor {
if (writeSheetHolder.isNew() && !writeSheetHolder.getExcelWriteHeadProperty().hasHead()) {
newRowIndex += writeContext.currentWriteHolder().relativeHeadRowIndex();
}
// BeanMap is out of order,so use sortedAllFiledMap
// BeanMap is out of order, so use sortedAllFiledMap
Map<Integer, Field> sortedAllFiledMap = new TreeMap<Integer, Field>();
int relativeRowIndex = 0;
for (Object oneRowData : data) {

10
src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java

@ -20,26 +20,26 @@ public class WriteWorkbook extends WriteBasicParameter {
/**
* Final output file
* <p>
* If 'outputStream' and 'file' all not empty,file first
* If 'outputStream' and 'file' all not empty, file first
*/
private File file;
/**
* Final output stream
* <p>
* If 'outputStream' and 'file' all not empty,file first
* If 'outputStream' and 'file' all not empty, file first
*/
private OutputStream outputStream;
/**
* Template input stream
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private InputStream templateInputStream;
/**
* Template file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private File templateFile;
/**
@ -58,7 +58,7 @@ public class WriteWorkbook extends WriteBasicParameter {
*/
private String password;
/**
* Write excel in memory. Default false,the cache file is created and finally written to excel.
* Write excel in memory. Default false, the cache file is created and finally written to excel.
* <p>
* Comment and RichTextString are only supported in memory mode.
*/

4
src/main/java/com/alibaba/excel/write/metadata/holder/WriteSheetHolder.java

@ -148,12 +148,12 @@ public class WriteSheetHolder extends AbstractWriteHolder {
}
/**
* Get the last line of index,you have to make sure that the data is written next
* Get the last line of index, you have to make sure that the data is written next
*
* @return
*/
public int getNewRowIndexAndStartDoWrite() {
// 'getLastRowNum' doesn't matter if it has one or zero,is's zero
// 'getLastRowNum' doesn't matter if it has one or zero, it's zero
int newRowIndex = 0;
switch (writeLastRowTypeEnum) {
case TEMPLATE_EMPTY:

8
src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java

@ -52,7 +52,7 @@ public class WriteWorkbookHolder extends AbstractWriteHolder {
/**
* Final output file
* <p>
* If 'outputStream' and 'file' all not empty,file first
* If 'outputStream' and 'file' all not empty, file first
*/
private File file;
/**
@ -62,13 +62,13 @@ public class WriteWorkbookHolder extends AbstractWriteHolder {
/**
* Template input stream
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private InputStream templateInputStream;
/**
* Template file
* <p>
* If 'inputStream' and 'file' all not empty,file first
* If 'inputStream' and 'file' all not empty, file first
*/
private File templateFile;
/**
@ -102,7 +102,7 @@ public class WriteWorkbookHolder extends AbstractWriteHolder {
*/
private String password;
/**
* Write excel in memory. Default false,the cache file is created and finally written to excel.
* Write excel in memory. Default false, the cache file is created and finally written to excel.
* <p>
* Comment and RichTextString are only supported in memory mode.
*/

2
src/main/java/com/alibaba/excel/write/metadata/style/WriteFont.java

@ -37,7 +37,7 @@ public class WriteFont {
*/
private Short color;
/**
* Set normal,super or subscript.
* Set normal, super or subscript.
*
* @see Font#SS_NONE
* @see Font#SS_SUPER

2
src/main/java/com/alibaba/excel/write/style/column/AbstractHeadColumnWidthStyleStrategy.java

@ -33,7 +33,7 @@ public abstract class AbstractHeadColumnWidthStyleStrategy extends AbstractColum
* Returns the column width corresponding to each column head.
*
* <p>
* if return null,ignore
* if return null, ignore
*
* @param head
* Nullable.

4
src/test/java/com/alibaba/easyexcel/test/core/compatibility/CompatibilityDataTest.java

@ -58,7 +58,7 @@ public class CompatibilityDataTest {
generateParam.setOutputStream(out);
generateParam.setClazz(null);
ExcelWriter writer = new ExcelWriter(generateParam);
// sheet1 width,string head,string data
// sheet1 width, string head, string data
Sheet sheet1 = new Sheet(1, 3);
sheet1.setSheetName("第一个sheet");
Map columnWidth = new HashMap();
@ -68,7 +68,7 @@ public class CompatibilityDataTest {
sheet1.setHead(head());
writer.write1(listData(), sheet1);
// sheet2 style,class head
// sheet2 style, class head
Sheet sheet2 = new Sheet(2, 3, CompatibilityData.class, "第二个sheet", null);
sheet2.setStartRow(5);
sheet2.setTableStyle(style());

Loading…
Cancel
Save