From ac79beaf6fbcbdd02906d1bbf93ea53984cc17ea Mon Sep 17 00:00:00 2001 From: lethal233 <11811407@mail.sustech.edu.cn> Date: Wed, 9 Jun 2021 20:48:24 +0800 Subject: [PATCH] fix comment typo like #1971 --- .../analysis/v07/handlers/CellTagHandler.java | 14 +++++++------- .../alibaba/excel/annotation/ExcelProperty.java | 2 +- .../annotation/write/style/ContentFontStyle.java | 2 +- .../annotation/write/style/HeadFontStyle.java | 2 +- .../java/com/alibaba/excel/metadata/CellExtra.java | 8 ++++---- .../excel/metadata/property/FontProperty.java | 2 +- .../excel/read/builder/ExcelReaderBuilder.java | 8 ++++---- .../alibaba/excel/read/metadata/ReadWorkbook.java | 6 +++--- .../read/metadata/holder/ReadWorkbookHolder.java | 6 +++--- .../excel/write/builder/ExcelWriterBuilder.java | 2 +- .../write/executor/AbstractExcelWriteExecutor.java | 4 ++-- .../write/executor/ExcelWriteAddExecutor.java | 2 +- .../excel/write/metadata/WriteWorkbook.java | 10 +++++----- .../write/metadata/holder/WriteSheetHolder.java | 4 ++-- .../write/metadata/holder/WriteWorkbookHolder.java | 8 ++++---- .../excel/write/metadata/style/WriteFont.java | 2 +- .../AbstractHeadColumnWidthStyleStrategy.java | 2 +- .../core/compatibility/CompatibilityDataTest.java | 4 ++-- 18 files changed, 44 insertions(+), 44 deletions(-) diff --git a/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java b/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java index fe5a6421..2224c19f 100644 --- a/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java +++ b/src/main/java/com/alibaba/excel/analysis/v07/handlers/CellTagHandler.java @@ -27,13 +27,13 @@ public class CellTagHandler extends AbstractXlsxTagHandler { xlsxReadSheetHolder.setColumnIndex(PositionUtils.getCol(attributes.getValue(ExcelXmlConstants.ATTRIBUTE_R), xlsxReadSheetHolder.getColumnIndex())); - // t="s" ,it's means String - // t="str" ,it's means String,but does not need to be read in the 'sharedStrings.xml' - // t="inlineStr" ,it's means String - // t="b" ,it's means Boolean - // t="e" ,it's means Error - // t="n" ,it's means Number - // t is null ,it's means Empty or Number + // t="s", it means String + // t="str", it means String, but does not need to be read in the 'sharedStrings.xml' + // t="inlineStr", it means String + // t="b", it means Boolean + // t="e", it means Error + // t="n", it means Number + // t is null, it means Empty or Number CellDataTypeEnum type = CellDataTypeEnum.buildFromCellType(attributes.getValue(ExcelXmlConstants.ATTRIBUTE_T)); xlsxReadSheetHolder.setTempCellData(new CellData(type)); xlsxReadSheetHolder.setTempData(new StringBuilder()); diff --git a/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java b/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java index 5c778a84..28e1ccd3 100644 --- a/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java +++ b/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 * diff --git a/src/main/java/com/alibaba/excel/annotation/write/style/ContentFontStyle.java b/src/main/java/com/alibaba/excel/annotation/write/style/ContentFontStyle.java index d593aef3..533ae6aa 100644 --- a/src/main/java/com/alibaba/excel/annotation/write/style/ContentFontStyle.java +++ b/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 diff --git a/src/main/java/com/alibaba/excel/annotation/write/style/HeadFontStyle.java b/src/main/java/com/alibaba/excel/annotation/write/style/HeadFontStyle.java index 957e50f5..d25dad77 100644 --- a/src/main/java/com/alibaba/excel/annotation/write/style/HeadFontStyle.java +++ b/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 diff --git a/src/main/java/com/alibaba/excel/metadata/CellExtra.java b/src/main/java/com/alibaba/excel/metadata/CellExtra.java index 937b9ac7..778f95fc 100644 --- a/src/main/java/com/alibaba/excel/metadata/CellExtra.java +++ b/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; diff --git a/src/main/java/com/alibaba/excel/metadata/property/FontProperty.java b/src/main/java/com/alibaba/excel/metadata/property/FontProperty.java index 04caf9bb..06aec863 100644 --- a/src/main/java/com/alibaba/excel/metadata/property/FontProperty.java +++ b/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 diff --git a/src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java b/src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java index 81f35862..b630eea2 100644 --- a/src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java +++ b/src/main/java/com/alibaba/excel/read/builder/ExcelReaderBuilder.java @@ -41,7 +41,7 @@ public class ExcelReaderBuilder extends AbstractExcelReaderParameterBuilder - * 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 - * 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 - * 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 - * 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); diff --git a/src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java b/src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java index c9e4db93..1ef7032f 100644 --- a/src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java +++ b/src/main/java/com/alibaba/excel/read/metadata/ReadWorkbook.java @@ -27,19 +27,19 @@ public class ReadWorkbook extends ReadBasicParameter { /** * Read InputStream *

- * If 'inputStream' and 'file' all not empty,file first + * If 'inputStream' and 'file' all not empty, file first */ private InputStream inputStream; /** * Read file *

- * 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. *

- * 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; /** diff --git a/src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java b/src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java index 375e32cc..c6462d94 100644 --- a/src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java +++ b/src/main/java/com/alibaba/excel/read/metadata/holder/ReadWorkbookHolder.java @@ -33,19 +33,19 @@ public class ReadWorkbookHolder extends AbstractReadHolder { /** * Read InputStream *

- * If 'inputStream' and 'file' all not empty,file first + * If 'inputStream' and 'file' all not empty, file first */ private InputStream inputStream; /** * Read file *

- * 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. *

- * 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; /** diff --git a/src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java b/src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java index 12c2f22f..3fb03236 100644 --- a/src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java +++ b/src/main/java/com/alibaba/excel/write/builder/ExcelWriterBuilder.java @@ -49,7 +49,7 @@ public class ExcelWriterBuilder extends AbstractExcelWriterParameterBuilder * Comment and RichTextString are only supported in memory mode. */ diff --git a/src/main/java/com/alibaba/excel/write/executor/AbstractExcelWriteExecutor.java b/src/main/java/com/alibaba/excel/write/executor/AbstractExcelWriteExecutor.java index 4eb115c5..38f6558b 100644 --- a/src/main/java/com/alibaba/excel/write/executor/AbstractExcelWriteExecutor.java +++ b/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; } diff --git a/src/main/java/com/alibaba/excel/write/executor/ExcelWriteAddExecutor.java b/src/main/java/com/alibaba/excel/write/executor/ExcelWriteAddExecutor.java index 9f229029..981293d3 100644 --- a/src/main/java/com/alibaba/excel/write/executor/ExcelWriteAddExecutor.java +++ b/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 sortedAllFiledMap = new TreeMap(); int relativeRowIndex = 0; for (Object oneRowData : data) { diff --git a/src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java b/src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java index c28e0412..d5850405 100644 --- a/src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java +++ b/src/main/java/com/alibaba/excel/write/metadata/WriteWorkbook.java @@ -20,26 +20,26 @@ public class WriteWorkbook extends WriteBasicParameter { /** * Final output file *

- * If 'outputStream' and 'file' all not empty,file first + * If 'outputStream' and 'file' all not empty, file first */ private File file; /** * Final output stream *

- * If 'outputStream' and 'file' all not empty,file first + * If 'outputStream' and 'file' all not empty, file first */ private OutputStream outputStream; /** * Template input stream *

- * If 'inputStream' and 'file' all not empty,file first + * If 'inputStream' and 'file' all not empty, file first */ private InputStream templateInputStream; /** * Template file *

- * 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. *

* Comment and RichTextString are only supported in memory mode. */ diff --git a/src/main/java/com/alibaba/excel/write/metadata/holder/WriteSheetHolder.java b/src/main/java/com/alibaba/excel/write/metadata/holder/WriteSheetHolder.java index 56fc7e4e..15b88292 100644 --- a/src/main/java/com/alibaba/excel/write/metadata/holder/WriteSheetHolder.java +++ b/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: diff --git a/src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java b/src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java index 8c84f1dc..999e7f10 100644 --- a/src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java +++ b/src/main/java/com/alibaba/excel/write/metadata/holder/WriteWorkbookHolder.java @@ -52,7 +52,7 @@ public class WriteWorkbookHolder extends AbstractWriteHolder { /** * Final output file *

- * 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 *

- * If 'inputStream' and 'file' all not empty,file first + * If 'inputStream' and 'file' all not empty, file first */ private InputStream templateInputStream; /** * Template file *

- * 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. *

* Comment and RichTextString are only supported in memory mode. */ diff --git a/src/main/java/com/alibaba/excel/write/metadata/style/WriteFont.java b/src/main/java/com/alibaba/excel/write/metadata/style/WriteFont.java index 6ed4c2a7..35fe7b92 100644 --- a/src/main/java/com/alibaba/excel/write/metadata/style/WriteFont.java +++ b/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 diff --git a/src/main/java/com/alibaba/excel/write/style/column/AbstractHeadColumnWidthStyleStrategy.java b/src/main/java/com/alibaba/excel/write/style/column/AbstractHeadColumnWidthStyleStrategy.java index 1a88eff6..14a76c71 100644 --- a/src/main/java/com/alibaba/excel/write/style/column/AbstractHeadColumnWidthStyleStrategy.java +++ b/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. * *

- * if return null,ignore + * if return null, ignore * * @param head * Nullable. diff --git a/src/test/java/com/alibaba/easyexcel/test/core/compatibility/CompatibilityDataTest.java b/src/test/java/com/alibaba/easyexcel/test/core/compatibility/CompatibilityDataTest.java index 258f055c..39ceff92 100644 --- a/src/test/java/com/alibaba/easyexcel/test/core/compatibility/CompatibilityDataTest.java +++ b/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());