- * This class will be removed in future versions. - *
+ * Legacy alias for {@link FesodSheet}. + * + *DEPRECATED: This class has been deprecated as part of the project's transition + * to the Apache Fesod branding. Users should migrate to {@link FesodSheet} for all new development. + * + *
Replace all occurrences of {@code EasyExcel} with {@code FesodSheet} in your codebase: + * + *
| Old Code (Deprecated) | + *New Code (Recommended) | + *
|---|---|
| {@code EasyExcel.read(file, DemoData.class, listener)} | + *{@code FesodSheet.read(file, DemoData.class, listener)} | + *
| {@code EasyExcel.write(file, DemoData.class)} | + *{@code FesodSheet.write(file, DemoData.class)} | + *
| {@code EasyExcel.readSheet(0)} | + *{@code FesodSheet.readSheet(0)} | + *
| {@code EasyExcel.writerSheet("Sheet1")} | + *{@code FesodSheet.writerSheet("Sheet1")} | + *
This class was originally named "EasyExcel" but has been superseded by "FesodSheet" + * to align with Apache Fesod's official branding and naming conventions. The functionality + * remains identical; only the class name has changed. + * + *
This class is marked for removal in a future major version. All functionality is + * available in {@link FesodSheet}. + * + * @deprecated Since version 1.0.0. Use {@link FesodSheet} instead. + * This class will be removed in a future major release. + * @see FesodSheet */ @Deprecated public class EasyExcel extends FesodSheet {} diff --git a/fesod/src/main/java/org/apache/fesod/sheet/FastExcel.java b/fesod/src/main/java/org/apache/fesod/sheet/FastExcel.java index 77080836..9e78acd6 100644 --- a/fesod/src/main/java/org/apache/fesod/sheet/FastExcel.java +++ b/fesod/src/main/java/org/apache/fesod/sheet/FastExcel.java @@ -20,11 +20,62 @@ package org.apache.fesod.sheet; /** - * An alias class for {@link FesodSheet}. - * This class is deprecated; use {@link FesodSheet} instead. - *
- * This class will be removed in future versions. - *
+ * Legacy short alias for {@link FesodSheet}. + * + *DEPRECATED: This class has been deprecated as part of the project's evolution + * from "FastExcel" to "Apache Fesod". Users should migrate to {@link FesodSheet} for all new development. + * + *
Replace all occurrences of {@code FastExcel} with {@code FesodSheet} in your codebase: + * + *
| Old Code (Deprecated) | + *New Code (Recommended) | + *
|---|---|
| {@code FastExcel.read("data.xlsx", DemoData.class, listener)} | + *{@code FesodSheet.read("data.xlsx", DemoData.class, listener)} | + *
| {@code FastExcel.write("output.xlsx", DemoData.class)} | + *{@code FesodSheet.write("output.xlsx", DemoData.class)} | + *
| {@code FastExcel.readSheet(0)} | + *{@code FesodSheet.readSheet(0)} | + *
| {@code FastExcel.writerSheet("MySheet")} | + *{@code FesodSheet.writerSheet("MySheet")} | + *
This class was originally named "FastExcel" to provide a short, memorable entry point + * for the library. However, following the project's acceptance into the Apache Software Foundation + * as Apache Fesod (incubating), it has been superseded by "FesodSheet" to align with the official + * project branding. The functionality remains identical; only the class name has changed. + * + *
The name "FastExcel" emphasized the library's high-performance characteristics and ease of use. + * The Apache Fesod name (Fast Easy Spreadsheet and Other Documents) retains this heritage while + * fitting Apache naming conventions. + * + *
Both {@code FastExcel} and {@link FastExcelFactory} are deprecated aliases pointing to + * the same underlying implementation. {@code FastExcel} was the short, convenient alias while + * {@code FastExcelFactory} used the explicit "Factory" suffix. + * + *
This class is marked for removal in a future major version. All functionality is + * available in {@link FesodSheet}. + * + * @deprecated Since version 1.0.0. Use {@link FesodSheet} instead. + * This class will be removed in a future major release. + * @see FesodSheet + * @see FastExcelFactory */ @Deprecated public class FastExcel extends FesodSheet {} diff --git a/fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java b/fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java index 60822aa6..a25463cd 100644 --- a/fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java +++ b/fesod/src/main/java/org/apache/fesod/sheet/FastExcelFactory.java @@ -20,11 +20,56 @@ package org.apache.fesod.sheet; /** - * An alias class for {@link FesodSheet}. - * This class is deprecated; use {@link FesodSheet} instead. - *
- * This class will be removed in future versions. - *
+ * Legacy factory class alias for {@link FesodSheet}. + * + *DEPRECATED: This class has been deprecated as part of the project's evolution + * from "FastExcel" to "Apache Fesod". Users should migrate to {@link FesodSheet} for all new development. + * + *
Replace all occurrences of {@code FastExcelFactory} with {@code FesodSheet} in your codebase: + * + *
| Old Code (Deprecated) | + *New Code (Recommended) | + *
|---|---|
| {@code FastExcelFactory.read(inputStream, DemoData.class, listener)} | + *{@code FesodSheet.read(inputStream, DemoData.class, listener)} | + *
| {@code FastExcelFactory.write(outputStream, DemoData.class)} | + *{@code FesodSheet.write(outputStream, DemoData.class)} | + *
| {@code FastExcelFactory.readSheet(0, "Sheet1")} | + *{@code FesodSheet.readSheet(0, "Sheet1")} | + *
| {@code FastExcelFactory.writerTable(0)} | + *{@code FesodSheet.writerTable(0)} | + *
This class was part of the original "FastExcel" branding but has been superseded by + * "FesodSheet" following the project's acceptance into the Apache Software Foundation as + * Apache Fesod (incubating). The functionality remains identical; only the class name has changed. + * + *
Both {@link FastExcel} and {@code FastExcelFactory} are deprecated aliases pointing to + * the same underlying implementation. {@code FastExcel} was the short alias while + * {@code FastExcelFactory} used the explicit "Factory" suffix. + * + *
This class is marked for removal in a future major version. All functionality is + * available in {@link FesodSheet}. + * + * @deprecated Since version 1.0.0. Use {@link FesodSheet} instead. + * This class will be removed in a future major release. + * @see FesodSheet + * @see FastExcel */ @Deprecated public class FastExcelFactory extends FesodSheet {} diff --git a/fesod/src/main/java/org/apache/fesod/sheet/FesodSheet.java b/fesod/src/main/java/org/apache/fesod/sheet/FesodSheet.java index 2422718a..d0864456 100644 --- a/fesod/src/main/java/org/apache/fesod/sheet/FesodSheet.java +++ b/fesod/src/main/java/org/apache/fesod/sheet/FesodSheet.java @@ -30,7 +30,67 @@ import org.apache.fesod.sheet.write.builder.ExcelWriterTableBuilder; /** - * Core classes of the Fesod spreadsheet processor + * Core factory class providing static methods for creating Excel readers and writers. + * + *
This class serves as the primary entry point for the Fesod library, offering a fluent API + * for both reading and writing Excel files. It provides a unified interface to simplify Excel + * operations through the builder pattern. + * + *
{@code
+ * // Simple read with listener
+ * FesodSheet.read("demo.xlsx", DemoData.class, new DemoDataListener())
+ * .sheet()
+ * .doRead();
+ *
+ * // Advanced read with custom configuration
+ * try (ExcelReader excelReader = FesodSheet.read(file)
+ * .headRowNumber(1)
+ * .ignoreEmptyRow(true)
+ * .build()) {
+ * ReadSheet readSheet = FesodSheet.readSheet(0).build();
+ * excelReader.read(readSheet);
+ * }
+ * }
+ *
+ * {@code
+ * // Simple write
+ * FesodSheet.write("output.xlsx", DemoData.class)
+ * .sheet("Sheet1")
+ * .doWrite(dataList);
+ *
+ * // Advanced write with custom configuration
+ * try (ExcelWriter excelWriter = FesodSheet.write(outputStream)
+ * .build()) {
+ * WriteSheet writeSheet = FesodSheet.writerSheet(0, "Template").build();
+ * excelWriter.write(dataList, writeSheet);
+ * }
+ * }
+ *
+ * The following classes are deprecated aliases that extend FesodSheet: + *