diff --git a/pom.xml b/pom.xml index 6303cd4b..0c4df87c 100644 --- a/pom.xml +++ b/pom.xml @@ -1,16 +1,64 @@ - + 4.0.0 - - com.alibaba - a2m.china - 3 - com.alibaba easyexcel - 1.0.0-RELEASE + 1.0.0 + + org.sonatype.oss + oss-parent + 7 + + jar + easyexcel + easyexcel is a excel handle tools written in Java + + https://github.com/alibaba/easyexcel + 2018 + + + 4.12 + true + false + UTF-8 + 1.7 + + + + https://github.com/alibaba/easyexcel + scm:git:https://git@github.com/alibaba/easyexcel.git + + + + + local-file + file://${basedir}/lib/ + default + + + + + Alibaba Group + https://github.com/alibaba + + + + + jipengfei + jipengfei + 1558143046@qq.com + + + + + + Apache 2 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + A business-friendly OSS license + + @@ -40,4 +88,110 @@ 1.14 + + + + org.apache.maven.wagon + wagon-webdav + 1.0-beta-2 + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 3.5.1 + + UTF-8 + ${jdk.version} + ${jdk.version} + + + + org.codehaus.plexus + plexus-compiler-javac + 2.7 + + + + + + org.apache.maven.plugins + maven-source-plugin + + + attach-sources + + jar-no-fork + + + + + true + + + + + org.apache.maven.plugins + maven-surefire-plugin + + + **/bvt/**/*.java + + + + + + maven-javadoc-plugin + + + attach-javadoc + + jar + + + + + ${javadoc.skip} + public + UTF-8 + UTF-8 + UTF-8 + + http://docs.oracle.com/javase/6/docs/api + + + + + + maven-gpg-plugin + + ${gpg.skip} + + + + sign-artifacts + verify + + sign + + + + + + + + + oss + jipengfei + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + oss + jipengfei + https://oss.sonatype.org/content/repositories/snapshots + + + \ No newline at end of file diff --git a/src/main/java/com/alibaba/excel/ExcelReader.java b/src/main/java/com/alibaba/excel/ExcelReader.java index ee36f476..49fa8b6d 100644 --- a/src/main/java/com/alibaba/excel/ExcelReader.java +++ b/src/main/java/com/alibaba/excel/ExcelReader.java @@ -67,7 +67,7 @@ public class ExcelReader { /** * 读取excel中包含哪些sheet * - * @return + * @return Sheets */ public List getSheets() { return analyser.getSheets(); diff --git a/src/main/java/com/alibaba/excel/ExcelWriter.java b/src/main/java/com/alibaba/excel/ExcelWriter.java index f15157b5..2fa58c4b 100644 --- a/src/main/java/com/alibaba/excel/ExcelWriter.java +++ b/src/main/java/com/alibaba/excel/ExcelWriter.java @@ -34,6 +34,7 @@ public class ExcelWriter { * * @param outputStream 文件输出流 * @param typeEnum 输出文件类型03或07，强烈建议使用07版（可以输出超大excel而不内存溢出） + * @param needHead 是否需要表头 */ public ExcelWriter(OutputStream outputStream, ExcelTypeEnum typeEnum, boolean needHead) { excelBuilder = new ExcelBuilderImpl(); @@ -55,7 +56,7 @@ public class ExcelWriter { /** * 生成多sheet,每个sheet一张表 * - * @param data List代表一行数据 + * @param data List代表一行数据 * @param sheet data写入某个sheet * @return this（当前引用） */ @@ -67,7 +68,7 @@ public class ExcelWriter { /** * 可生成多sheet,每个sheet多张表 * - * @param data type is 一个java模型一行数据 + * @param data type 一个java模型一行数据 * @param sheet data写入某个sheet * @param table data写入某个table * @return this（当前引用） @@ -80,7 +81,7 @@ public class ExcelWriter { /** * 可生成多sheet,每个sheet多张表 * - * @param data List 代表一行数据 + * @param data List 代表一行数据 * @param sheet data写入某个sheet * @param table data写入某个table * @return this（当前引用） diff --git a/src/main/java/com/alibaba/excel/analysis/ExcelAnalyser.java b/src/main/java/com/alibaba/excel/analysis/ExcelAnalyser.java index 3957998f..dad87300 100644 --- a/src/main/java/com/alibaba/excel/analysis/ExcelAnalyser.java +++ b/src/main/java/com/alibaba/excel/analysis/ExcelAnalyser.java @@ -21,7 +21,7 @@ public interface ExcelAnalyser { * @param excelTypeEnum 解析文件类型 * @param custom 用户自定义参数用户回调时候可以获取到 * @param eventListener 解析器需要的监听器 - * @param trim + * @param trim 是否去空格 */ void init(InputStream inputStream, ExcelTypeEnum excelTypeEnum, Object custom, AnalysisEventListener eventListener, boolean trim); @@ -29,21 +29,21 @@ public interface ExcelAnalyser { /** * 解析指定sheet,{@link AnalysisEventListener}监听中使用 * - * @param sheetParam + * @param sheetParam 入参 */ void analysis(Sheet sheetParam); /** * - * 默认解析第一个sheet，解析结果以List 的格式在 {@link AnalysisEventListener}监听中使用 + * 默认解析第一个sheet，解析结果在 {@link AnalysisEventListener}监听中使用 */ void analysis(); /** * 返回excel中包含哪些sheet * - * @return + * @return 返回所有sheet */ List getSheets(); diff --git a/src/main/java/com/alibaba/excel/analysis/SaxAnalyserV07.java b/src/main/java/com/alibaba/excel/analysis/SaxAnalyserV07.java index 6c81bb32..eec983b2 100644 --- a/src/main/java/com/alibaba/excel/analysis/SaxAnalyserV07.java +++ b/src/main/java/com/alibaba/excel/analysis/SaxAnalyserV07.java @@ -33,7 +33,7 @@ import org.xml.sax.helpers.DefaultHandler; /** * @author jipengfei - * @date 2017/08/27 + * */ public class SaxAnalyserV07 extends BaseSaxAnalyser { diff --git a/src/main/java/com/alibaba/excel/analysis/v07/RowHandler.java b/src/main/java/com/alibaba/excel/analysis/v07/RowHandler.java index d237b82c..e744b06f 100644 --- a/src/main/java/com/alibaba/excel/analysis/v07/RowHandler.java +++ b/src/main/java/com/alibaba/excel/analysis/v07/RowHandler.java @@ -23,7 +23,7 @@ import static com.alibaba.excel.constant.ExcelXmlConstants.ROW_TAG; /** * @author jipengfei - * @date 2017/08/23 + * */ public class RowHandler extends DefaultHandler { diff --git a/src/main/java/com/alibaba/excel/analysis/v07/XMLTempFile.java b/src/main/java/com/alibaba/excel/analysis/v07/XMLTempFile.java index 89b29a99..6378e8a4 100644 --- a/src/main/java/com/alibaba/excel/analysis/v07/XMLTempFile.java +++ b/src/main/java/com/alibaba/excel/analysis/v07/XMLTempFile.java @@ -7,7 +7,7 @@ import com.alibaba.excel.util.EasyExcelTempFile; /** * @author jipengfei - * @date 2017/10/13 + * */ public class XMLTempFile { diff --git a/src/main/java/com/alibaba/excel/analysis/v07/XmlParserFactory.java b/src/main/java/com/alibaba/excel/analysis/v07/XmlParserFactory.java index 36b392f7..dba7f170 100644 --- a/src/main/java/com/alibaba/excel/analysis/v07/XmlParserFactory.java +++ b/src/main/java/com/alibaba/excel/analysis/v07/XmlParserFactory.java @@ -14,7 +14,7 @@ import org.xml.sax.XMLReader; /** * @author jipengfei - * @date 2017/10/13 + * */ public class XmlParserFactory { diff --git a/src/main/java/com/alibaba/excel/annotation/ExcelColumnNum.java b/src/main/java/com/alibaba/excel/annotation/ExcelColumnNum.java index 01220980..3b3ee817 100644 --- a/src/main/java/com/alibaba/excel/annotation/ExcelColumnNum.java +++ b/src/main/java/com/alibaba/excel/annotation/ExcelColumnNum.java @@ -11,7 +11,7 @@ import java.lang.annotation.Target; * Field column num at excel head * * @author jipengfei - * @date 2017/03/19 + * */ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @@ -20,7 +20,7 @@ public @interface ExcelColumnNum { /** * col num - * @return + * @return col num */ int value(); @@ -29,7 +29,7 @@ public @interface ExcelColumnNum { * Default @see com.alibaba.TypeUtil * if default is not meet you can set format * - * @return + * @return format */ String format() default ""; } diff --git a/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java b/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java index 51617d7e..2d2d355a 100644 --- a/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java +++ b/src/main/java/com/alibaba/excel/annotation/ExcelProperty.java @@ -16,14 +16,14 @@ public @interface ExcelProperty { /** * 某列表头值 - * @return + * @return 表头值 */ String[] value() default {""}; /** * 列顺序，越小越靠前 - * @return + * @return 列顺序 */ int index() default 99999; @@ -32,7 +32,7 @@ public @interface ExcelProperty { * default @see com.alibaba.TypeUtil * if default is not meet you can set format * - * @return + * @return 日期格式化 */ String format() default ""; } diff --git a/src/main/java/com/alibaba/excel/annotation/FieldType.java b/src/main/java/com/alibaba/excel/annotation/FieldType.java index e5dc48df..8d2e57b3 100644 --- a/src/main/java/com/alibaba/excel/annotation/FieldType.java +++ b/src/main/java/com/alibaba/excel/annotation/FieldType.java @@ -3,7 +3,7 @@ package com.alibaba.excel.annotation; /** * * @author jipengfei - * @date 2017/03/15 + * */ public enum FieldType { diff --git a/src/main/java/com/alibaba/excel/constant/ExcelXmlConstants.java b/src/main/java/com/alibaba/excel/constant/ExcelXmlConstants.java index 8403f9e3..345ff012 100644 --- a/src/main/java/com/alibaba/excel/constant/ExcelXmlConstants.java +++ b/src/main/java/com/alibaba/excel/constant/ExcelXmlConstants.java @@ -2,7 +2,7 @@ package com.alibaba.excel.constant; /** * @author jipengfei - * @date 2017/08/24 + * */ public class ExcelXmlConstants { public static final String DIMENSION = "dimension"; diff --git a/src/main/java/com/alibaba/excel/context/AnalysisContext.java b/src/main/java/com/alibaba/excel/context/AnalysisContext.java index e2631bcf..f69e2291 100644 --- a/src/main/java/com/alibaba/excel/context/AnalysisContext.java +++ b/src/main/java/com/alibaba/excel/context/AnalysisContext.java @@ -33,7 +33,7 @@ public interface AnalysisContext { /** * 设置当前解析的Sheet * - * @param sheet + * @param sheet 入参 */ void setCurrentSheet(Sheet sheet); @@ -54,28 +54,28 @@ public interface AnalysisContext { /** * 获取当前监听者 * - * @return + * @return listener */ AnalysisEventListener getEventListener(); /** * 获取当前行数 * - * @return + * @return 当前行 */ Integer getCurrentRowNum(); /** * 设置当前行数 * - * @param row + * @param row 设置行号 */ void setCurrentRowNum(Integer row); /** * 返回当前sheet共有多少行数据，仅限07版excel * - * @return + * @return 总行数 */ @Deprecated Integer getTotalCount(); @@ -83,57 +83,58 @@ public interface AnalysisContext { /** * 设置总条数 * - * @param totalCount + * @param totalCount 总行数 */ void setTotalCount(Integer totalCount); /** * 返回表头信息 * - * @return + * @return 表头信息 */ ExcelHeadProperty getExcelHeadProperty(); /** * 构建 ExcelHeadProperty * - * @param clazz - * @param headOneRow + * @param clazz 自定义model + * @param headOneRow 表头内容 */ void buildExcelHeadProperty(Class clazz, List headOneRow); /** * 是否trim() * - * @return + * @return 是否trim */ boolean trim(); /** * + * @param result 解析结果 */ void setCurrentRowAnalysisResult(Object result); - /** * + * @return 当前行解析结果 */ Object getCurrentRowAnalysisResult(); /** - * + * 中断 */ void interrupt(); /** * - * @return + * @return 是否use1904WindowDate */ boolean use1904WindowDate(); /** * - * @param use1904WindowDate + * @param use1904WindowDate 是否use1904WindowDate */ void setUse1904WindowDate(boolean use1904WindowDate); } diff --git a/src/main/java/com/alibaba/excel/context/GenerateContext.java b/src/main/java/com/alibaba/excel/context/GenerateContext.java index 3f001c6d..adcce3bc 100644 --- a/src/main/java/com/alibaba/excel/context/GenerateContext.java +++ b/src/main/java/com/alibaba/excel/context/GenerateContext.java @@ -24,26 +24,26 @@ public interface GenerateContext { /** * * 获取表头样式 - * @return + * @return 当前行表头样式 */ CellStyle getCurrentHeadCellStyle(); /** * 获取内容样式 - * @return + * @return 当前行内容样式 */ CellStyle getCurrentContentStyle(); /** * 返回WorkBook - * @return + * @return 返回文件book */ Workbook getWorkbook(); /** * 返回Io流 - * @return + * @return 返回out流 */ OutputStream getOutputStream(); @@ -61,13 +61,13 @@ public interface GenerateContext { /** * 返回表头信息 - * @return + * @return 返回表头信息 */ ExcelHeadProperty getExcelHeadProperty(); /** * - * @return + * @return 是否需要表头 */ boolean needHead(); } diff --git a/src/main/java/com/alibaba/excel/event/AnalysisEventListener.java b/src/main/java/com/alibaba/excel/event/AnalysisEventListener.java index d055250c..39c49e9d 100644 --- a/src/main/java/com/alibaba/excel/event/AnalysisEventListener.java +++ b/src/main/java/com/alibaba/excel/event/AnalysisEventListener.java @@ -24,7 +24,7 @@ public abstract class AnalysisEventListener { /** * if have something to do after all analysis * - * @param context + * @param context context */ public abstract void doAfterAllAnalysed(AnalysisContext context); } diff --git a/src/main/java/com/alibaba/excel/event/AnalysisEventRegisterCenter.java b/src/main/java/com/alibaba/excel/event/AnalysisEventRegisterCenter.java index 8f935f33..ae3a9eef 100644 --- a/src/main/java/com/alibaba/excel/event/AnalysisEventRegisterCenter.java +++ b/src/main/java/com/alibaba/excel/event/AnalysisEventRegisterCenter.java @@ -10,15 +10,15 @@ public interface AnalysisEventRegisterCenter { /** * 增加监听者 - * @param name - * @param listener + * @param name 名称 + * @param listener 监听器 */ void appendLister(String name, AnalysisEventListener listener); /** * 通知所有监听者 - * @param event + * @param event 事件 */ void notifyListeners(OneRowAnalysisFinishEvent event); diff --git a/src/main/java/com/alibaba/excel/event/OneRowAnalysisFinishEvent.java b/src/main/java/com/alibaba/excel/event/OneRowAnalysisFinishEvent.java index a9e9966d..9ebdb5a1 100644 --- a/src/main/java/com/alibaba/excel/event/OneRowAnalysisFinishEvent.java +++ b/src/main/java/com/alibaba/excel/event/OneRowAnalysisFinishEvent.java @@ -2,7 +2,6 @@ package com.alibaba.excel.event; /** * @author jipengfei - * @date 2017/07/21 */ public class OneRowAnalysisFinishEvent { diff --git a/src/main/java/com/alibaba/excel/metadata/CellRange.java b/src/main/java/com/alibaba/excel/metadata/CellRange.java index 7fac539b..6805526e 100644 --- a/src/main/java/com/alibaba/excel/metadata/CellRange.java +++ b/src/main/java/com/alibaba/excel/metadata/CellRange.java @@ -2,7 +2,6 @@ package com.alibaba.excel.metadata; /** * @author jipengfei - * @date 2017/06/02 */ public class CellRange { diff --git a/src/main/java/com/alibaba/excel/metadata/ExcelColumnProperty.java b/src/main/java/com/alibaba/excel/metadata/ExcelColumnProperty.java index 82e554c3..d8ece783 100644 --- a/src/main/java/com/alibaba/excel/metadata/ExcelColumnProperty.java +++ b/src/main/java/com/alibaba/excel/metadata/ExcelColumnProperty.java @@ -6,7 +6,6 @@ import java.util.List; /** * @author jipengfei - * @date 2017/05/31 */ public class ExcelColumnProperty implements Comparable { diff --git a/src/main/java/com/alibaba/excel/metadata/ExcelHeadProperty.java b/src/main/java/com/alibaba/excel/metadata/ExcelHeadProperty.java index 2e188c8c..c2ef3d8c 100644 --- a/src/main/java/com/alibaba/excel/metadata/ExcelHeadProperty.java +++ b/src/main/java/com/alibaba/excel/metadata/ExcelHeadProperty.java @@ -15,7 +15,6 @@ import com.alibaba.excel.annotation.ExcelProperty; * 表头信息 * * @author jipengfei - * @date 2017/05/31 */ public class ExcelHeadProperty { @@ -120,8 +119,8 @@ public class ExcelHeadProperty { /** * 根据Excel中的列号，获取Excel的表头信息 * - * @param columnNum - * @return + * @param columnNum 列号 + * @return ExcelColumnProperty */ public ExcelColumnProperty getExcelColumnProperty(int columnNum) { ExcelColumnProperty excelColumnProperty = excelColumnPropertyMap1.get(columnNum); diff --git a/src/main/java/com/alibaba/excel/metadata/Font.java b/src/main/java/com/alibaba/excel/metadata/Font.java index aae38755..f5453e10 100644 --- a/src/main/java/com/alibaba/excel/metadata/Font.java +++ b/src/main/java/com/alibaba/excel/metadata/Font.java @@ -4,7 +4,6 @@ package com.alibaba.excel.metadata; * 字体样式 * * @author jipengfei - * @date 2017/05/24 */ public class Font { diff --git a/src/main/java/com/alibaba/excel/metadata/Table.java b/src/main/java/com/alibaba/excel/metadata/Table.java index 37afefc5..a2f9290b 100644 --- a/src/main/java/com/alibaba/excel/metadata/Table.java +++ b/src/main/java/com/alibaba/excel/metadata/Table.java @@ -4,7 +4,6 @@ import java.util.List; /** * @author jipengfei - * @date 2017/05/16 */ public class Table { /** diff --git a/src/main/java/com/alibaba/excel/metadata/TableStyle.java b/src/main/java/com/alibaba/excel/metadata/TableStyle.java index 6618197e..228019c3 100644 --- a/src/main/java/com/alibaba/excel/metadata/TableStyle.java +++ b/src/main/java/com/alibaba/excel/metadata/TableStyle.java @@ -4,7 +4,6 @@ import org.apache.poi.ss.usermodel.IndexedColors; /** * @author jipengfei - * @date 2017/05/24 */ public class TableStyle { diff --git a/src/main/java/com/alibaba/excel/parameter/ExcelWriteParam.java b/src/main/java/com/alibaba/excel/parameter/ExcelWriteParam.java index 53665e86..ce42f9ff 100644 --- a/src/main/java/com/alibaba/excel/parameter/ExcelWriteParam.java +++ b/src/main/java/com/alibaba/excel/parameter/ExcelWriteParam.java @@ -8,7 +8,6 @@ import com.alibaba.excel.support.ExcelTypeEnum; * 为方便使用废弃该入参。直接将outputStream，type传入{@link com.alibaba.excel.ExcelWriter}的构造器即可 * * @author jipengfei - * @date 2017/05/15 */ @Deprecated public class ExcelWriteParam { diff --git a/src/main/java/com/alibaba/excel/util/EasyExcelTempFile.java b/src/main/java/com/alibaba/excel/util/EasyExcelTempFile.java index eb6584f3..05f9113e 100644 --- a/src/main/java/com/alibaba/excel/util/EasyExcelTempFile.java +++ b/src/main/java/com/alibaba/excel/util/EasyExcelTempFile.java @@ -6,7 +6,6 @@ import java.io.File; * 用于修复POI {@link org.apache.poi.util.DefaultTempFileCreationStrategy}在并发写，创建临时目录抛出异常的BUG。 * * @author jipengfei - * @date 2017/06/22 */ public class EasyExcelTempFile { @@ -35,6 +34,7 @@ public class EasyExcelTempFile { /** * 获取环境变量的配置 + * @return easyexcel临时目录 */ public static String getEasyExcelTmpDir() { String tmpDir = System.getProperty(JAVA_IO_TMPDIR); diff --git a/src/main/java/com/alibaba/excel/util/FileUtil.java b/src/main/java/com/alibaba/excel/util/FileUtil.java index f4376589..a7906135 100644 --- a/src/main/java/com/alibaba/excel/util/FileUtil.java +++ b/src/main/java/com/alibaba/excel/util/FileUtil.java @@ -14,7 +14,6 @@ import org.apache.commons.compress.utils.IOUtils; /** * @author jipengfei - * @date 2017/10/10 */ public class FileUtil { diff --git a/src/main/java/com/alibaba/excel/util/IndexValueConverter.java b/src/main/java/com/alibaba/excel/util/IndexValueConverter.java index af8ac7e1..a0c1529c 100644 --- a/src/main/java/com/alibaba/excel/util/IndexValueConverter.java +++ b/src/main/java/com/alibaba/excel/util/IndexValueConverter.java @@ -9,7 +9,6 @@ import com.alibaba.excel.metadata.IndexValue; /** * 去除空Cell * @author jipengfei - * @date 2017/04/13 */ public class IndexValueConverter { public static List converter(List i_list) { diff --git a/src/main/java/com/alibaba/excel/util/PositionUtils.java b/src/main/java/com/alibaba/excel/util/PositionUtils.java index f5f084ac..37a87dd5 100644 --- a/src/main/java/com/alibaba/excel/util/PositionUtils.java +++ b/src/main/java/com/alibaba/excel/util/PositionUtils.java @@ -2,7 +2,6 @@ package com.alibaba.excel.util; /** * @author jipengfei - * @date 2017/08/27 */ public class PositionUtils { diff --git a/src/main/java/com/alibaba/excel/util/TypeUtil.java b/src/main/java/com/alibaba/excel/util/TypeUtil.java index 79975224..3ae92f94 100644 --- a/src/main/java/com/alibaba/excel/util/TypeUtil.java +++ b/src/main/java/com/alibaba/excel/util/TypeUtil.java @@ -16,7 +16,6 @@ import org.apache.poi.hssf.usermodel.HSSFDateUtil; * 类型转换工具类 * * @author jipengfei - * @date 2017/03/15 */ public class TypeUtil { diff --git a/src/main/java/com/alibaba/excel/write/ExcelBuilder.java b/src/main/java/com/alibaba/excel/write/ExcelBuilder.java index 63d373f0..4385ea8d 100644 --- a/src/main/java/com/alibaba/excel/write/ExcelBuilder.java +++ b/src/main/java/com/alibaba/excel/write/ExcelBuilder.java @@ -26,14 +26,14 @@ public interface ExcelBuilder { /** * 向Excel增加的内容 * - * @param data 数据格式 {@link List < String >} 或{@link List } + * @param data 数据格式 */ void addContent(List data); /** * 向Excel增加的内容 * - * @param data 数据格式 {@link List < String >} 或{@link List } + * @param data 数据格式 * @param sheetParam 数据写到某个sheet中 */ void addContent(List data, Sheet sheetParam); @@ -41,7 +41,7 @@ public interface ExcelBuilder { /** * 向Excel增加的内容 * - * @param data 数据格式 {@link List < String >} 或{@link List } + * @param data 数据格式 * @param sheetParam 数据写到某个sheet中 * @param table 写到某个sheet的某个Table */ diff --git a/src/main/java/com/alibaba/excel/write/ExcelBuilderImpl.java b/src/main/java/com/alibaba/excel/write/ExcelBuilderImpl.java index 9d306cc7..fd656902 100644 --- a/src/main/java/com/alibaba/excel/write/ExcelBuilderImpl.java +++ b/src/main/java/com/alibaba/excel/write/ExcelBuilderImpl.java @@ -18,7 +18,6 @@ import org.apache.poi.ss.usermodel.Row; /** * @author jipengfei - * @date 2017/05/27 */ public class ExcelBuilderImpl implements ExcelBuilder {