Skip to content

Commit acfb590

Browse files
MatrixSevenMatrixSeven
committed
配置JavaDoc
1 parent 1d3d6ba commit acfb590

File tree

6 files changed

+79
-76
lines changed

6 files changed

+79
-76
lines changed

‎pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,13 @@
9292
<executions>
9393
<execution>
9494
<id>attach-javadocs</id>
95+
<phase>package</phase>
9596
<goals>
9697
<goal>jar</goal>
9798
</goals>
99+
<configuration>
100+
<additionalparam>-Xdoclint:none</additionalparam>
101+
</configuration>
98102
</execution>
99103
</executions>
100104
</plugin>

‎src/main/java/seven/ExcelFactory.java‎

Lines changed: 42 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package seven;
22

3-
import org.apache.poi.ss.formula.functions.T;
43
import seven.callBack.PackageDataInterface;
54
import seven.config.Config;
65
import seven.savewapper.SaveExcel;
@@ -10,7 +9,6 @@
109
import seven.savewapper.wapperRef.sysWppers.ResExportObj;
1110
import seven.wapperInt.ReaderMap;
1211
import seven.wapperInt.ReaderObj;
13-
import seven.wapperInt.wapperRef.WrapperObj;
1412
import seven.wapperInt.wapperRef.sysWppers.ResWrapperMap;
1513
import seven.wapperInt.wapperRef.sysWppers.ResWrapperObj;
1614

@@ -51,9 +49,8 @@ private ExcelFactory() {
5149
* 读取Excel
5250
*
5351
* @param FilePath 路径
54-
* @param r 包装类
5552
* @return Wrapper
56-
* @throws Exception
53+
* @throws Exception Exception
5754
*/
5855
public static ReaderMap getMaps(String FilePath) throws Exception {
5956
return (ReaderMap) new ResWrapperMap(it->{}).init(FilePath);
@@ -63,9 +60,8 @@ public static ReaderMap getMaps(String FilePath) throws Exception {
6360
* 读取Excel
6461
*
6562
* @param FilePath 路径
66-
* @param r 包装类
6763
* @return Wrapper
68-
* @throws Exception
64+
* @throws Exception Exception
6965
*/
7066
public static <T> ReaderObj<T> getBeans(Class clazz,String FilePath) throws Exception {
7167
return new ResWrapperObj(clazz,it->{}).init(FilePath);
@@ -77,7 +73,7 @@ public static <T> ReaderObj<T> getBeans(Class clazz,String FilePath) throws Exce
7773
* @param FilePath 路径
7874
* @param r 包装类
7975
* @return Wrapper
80-
* @throws Exception
76+
* @throws Exception Exception
8177
*/
8278
public static ReaderMap getMaps(String FilePath, Consumer<Config> config) throws Exception {
8379
return (ReaderMap) new ResWrapperMap(config).init(FilePath);
@@ -87,7 +83,9 @@ public static ReaderMap getMaps(String FilePath, Consumer<Config> config) throws
8783
* 读取Excel
8884
*
8985
* @param FilePath 路径
90-
* @param r 包装类
86+
* @param clazz clazz
87+
* @param config config
88+
* @param <T> t
9189
* @return Wrapper
9290
* @throws Exception
9391
*/
@@ -97,75 +95,58 @@ public static <T> ReaderObj<T> getBeans(Class clazz,String FilePath, Consumer<Co
9795

9896
/**
9997
* 读取Excel
100-
*
101-
* @param FilePath 路径
102-
* @param r 包装类
98+
* @param file file
10399
* @return Wrapper
104-
* @throws Exception
100+
* @throws Exception Exception
105101
*/
106102
public static ReaderMap getMaps(File file) throws Exception {
107103
return (ReaderMap) new ResWrapperMap(it->{}).init(file);
108104
}
109105

110106
/**
111107
* 读取Excel
112-
*
113-
* @param FilePath 路径
114-
* @param r 包装类
108+
* @param clazz clazz
109+
* @param file file
110+
* @param <T> T
115111
* @return Wrapper
116-
* @throws Exception
112+
* @throws Exception Exception
117113
*/
118-
public static <T> ReaderObj<T> getBeans(Class clazz,File file) throws Exception {
114+
public static <T> ReaderObj<T> getBeans(Class<?> clazz,File file) throws Exception {
119115
return new ResWrapperObj(clazz,it->{}).init(file);
120116
}
121117

122118
/**
123119
* 读取Excel
124-
*
125-
* @param FilePath 路径
126-
* @param r 包装类
120+
* @param file file
121+
* @param config config
127122
* @return Wrapper
128-
* @throws Exception
123+
* @throws Exception Exception
129124
*/
130125
public static ReaderMap getMaps(File file, Consumer<Config> config) throws Exception {
131126
return (ReaderMap) new ResWrapperMap(config).init(file);
132127
}
133128

129+
134130
/**
135131
* 读取Excel
136-
*
137-
* @param FilePath 路径
138-
* @param r 包装类
139-
* @return Wrapper
140-
* @throws Exception
132+
* @param clazz clazz
133+
* @param file file
134+
* @param config config
135+
* @param <T> <T>
136+
* @return T
137+
* @throws Exception Exception
141138
*/
142-
public static <T> ReaderObj<T> getBeans(Class clazz,File file, Consumer<Config> config) throws Exception {
139+
public static <T> ReaderObj<T> getBeans(Class<?> clazz,File file, Consumer<Config> config) throws Exception {
143140
return new ResWrapperObj(clazz, config).init(file);
144141
}
145142

146-
147-
148-
149-
150-
151-
152-
153-
154-
155-
156-
157-
158-
159-
160-
161-
162143
/**
163144
* 保存Excel
164-
*
165-
* @param bean
166-
* @param FilePath
145+
* @param <T> T
146+
* @param bean bean
147+
* @param FilePath FilePath
167148
* @return SaveExcel
168-
* @throws Exception
149+
* @throws Exception Exception
169150
*/
170151
public static <T> SaveExcel<T> saveExcel(List<? extends T> bean, String FilePath) throws Exception {
171152
if (bean.size() < 1) {
@@ -180,9 +161,9 @@ public static <T> SaveExcel<T> saveExcel(List<? extends T> bean, String FilePath
180161
/**
181162
* 保存Excel
182163
*
183-
* @param bean
164+
* @param bean bean
184165
* @return SaveExcel
185-
* @throws Exception
166+
* @throws Exception Exception
186167
*/
187168
public static SaveExcel saveExcel(List<? extends Object> bean) throws Exception {
188169
if (bean.size() < 1) {
@@ -198,10 +179,10 @@ public static SaveExcel saveExcel(List<? extends Object> bean) throws Exception
198179
/**
199180
* 保存Excel
200181
*
201-
* @param resultSet
202-
* @param FilePath
182+
* @param resultSet resultSet
183+
* @param FilePath FilePath
203184
* @return SaveExcel
204-
* @throws Exception
185+
* @throws Exception Exception
205186
*/
206187
public static SaveExcel saveExcel(ResultSet resultSet, String FilePath) throws Exception {
207188
return new ResExportDBMap(resultSet, FilePath);
@@ -210,11 +191,11 @@ public static SaveExcel saveExcel(ResultSet resultSet, String FilePath) throws E
210191
/**
211192
* 保存Excel
212193
*
213-
* @param resultSet
214-
* @param FilePath
215-
* @param packageDataInterface
194+
* @param resultSet resultSet
195+
* @param FilePath FilePath
196+
* @param packageDataInterface packageDataInterface
216197
* @return SaveExcel
217-
* @throws Exception
198+
* @throws Exception Exception
218199
*/
219200
public static SaveExcel saveExcel(ResultSet resultSet, String FilePath, PackageDataInterface packageDataInterface) throws Exception {
220201
return new ResExportDBObj(resultSet, FilePath, packageDataInterface);
@@ -223,10 +204,10 @@ public static SaveExcel saveExcel(ResultSet resultSet, String FilePath, PackageD
223204
/**
224205
* 保存Excel
225206
*
226-
* @param resultSet
227-
* @param type
207+
* @param resultSet resultSet
208+
* @param type type
228209
* @return SaveExcel
229-
* @throws Exception
210+
* @throws Exception Exception
230211
*/
231212
public static SaveExcel saveExcel(ResultSet resultSet, Class type) throws Exception {
232213
return new ResExportDBObj(resultSet, type);
@@ -236,9 +217,9 @@ public static SaveExcel saveExcel(ResultSet resultSet, Class type) throws Except
236217
/**
237218
* 保存Excel
238219
*
239-
* @param resultSet
220+
* @param resultSet resultSet
240221
* @return SaveExcel
241-
* @throws Exception
222+
* @throws Exception Exception
242223
*/
243224
public static SaveExcel saveExcel(ResultSet resultSet) throws Exception {
244225
return new ResExportDBMap(resultSet);

‎src/main/java/seven/ExcelSuperInterface.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
import seven.callBack.DataFilterColumnInterface;
1919
import seven.callBack.DataFilterInterface;
2020
import seven.callBack.DataFilterProcessInterface;
21-
import seven.wapperInt.Wrapper;
2221

2322
import java.util.Comparator;
2423
import java.util.List;
@@ -36,7 +35,7 @@ public interface ExcelSuperInterface<T,R> {
3635
* 如果返回false将放弃此条数据
3736
*
3837
* @param filter {@link DataFilterInterface}
39-
* @return Wrapper
38+
* @return Wrapper Wrapper
4039
*/
4140
T Filter(DataFilterInterface<? extends R> filter);
4241

@@ -45,15 +44,15 @@ public interface ExcelSuperInterface<T,R> {
4544
* 在process方法里可对属性进行处理加工
4645
*
4746
* @param process {@link DataFilterProcessInterface}
48-
* @return Wrapper
47+
* @return Wrapper Wrapper
4948
*/
5049
T Process(DataFilterProcessInterface<? extends R> process);
5150

5251
/**
5352
* 对结果的List进行排序
5453
*
55-
* @param c
56-
* @return Wrapper
54+
* @param c c
55+
* @return Wrapper Wrapper
5756
*/
5857
T Sort(Comparator<? extends R> c);
5958

@@ -62,6 +61,7 @@ public interface ExcelSuperInterface<T,R> {
6261
* 如果加入后，将不对实体进行赋值
6362
*
6463
* @param consumer {@link DataFilterColumnInterface}
64+
* @return Wrapper Wrapper
6565
*/
6666
T FilterCol(Consumer<List<String>> consumer);
6767

‎src/main/java/seven/config/Config.java‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ public class Config {
2424
private Integer endSheet = null;
2525
private Integer sheetIndex = -1;
2626
private String sheetName = null;
27-
private Map<String, Class<? extends ConvertInterface<?>>> convertMap = new HashMap<>();
27+
private Map<String, Class<? extends ConvertInterface
28+
<?>>> convertMap = new HashMap<>();
2829
private Map<String, ConvertInterface<?>> convertMapImpl = new HashMap<>();
2930

3031
public Config() {
@@ -53,7 +54,7 @@ public String[] getRequire() {
5354
* Map数据个校验数组
5455
* <p>
5556
* 支持正则表达式
56-
*
57+
* @param require require
5758
* @see seven.util.RegHelper
5859
*/
5960
@Deprecated
@@ -68,8 +69,8 @@ public Integer getVocSize() {
6869
/**
6970
* Excel数据容器<br>
7071
* 当数据大于5w时，最好初始化为大于或者等于当前excel行数 最好设置大于或者
71-
*
72-
* @param vocSize
72+
* @return Config Config
73+
* @param vocSize vocSize
7374
*/
7475
public Config vocSize(Integer vocSize) {
7576
this.vocSize = vocSize;
@@ -85,16 +86,22 @@ public Config setErrorLog(Boolean errorLog) {
8586
return this;
8687
}
8788

89+
/**
90+
*
91+
* @param name name
92+
* @param clazz clazz
93+
* @return Config Config
94+
*/
8895
@Deprecated
8996
public Config withConvert(String name, Class<? extends ConvertInterface<?>> clazz) {
9097
this.convertMap.put(name, clazz);
9198
return this;
9299
}
93100

94101
/**
95-
* @param name
96-
* @param convert
97-
* @return
102+
* @param name name
103+
* @param convert convert
104+
* @return Config
98105
*/
99106
@Deprecated
100107
public Config withConvert(String name, ConvertInterface<?> convert) {
@@ -106,15 +113,26 @@ public Integer getSheetIndex() {
106113
return sheetIndex;
107114
}
108115

116+
/**
117+
* @param sheetIndex
118+
* @return Config Config
119+
*/
109120
public Config setSheetIndex(Integer sheetIndex) {
110121
this.sheetIndex = sheetIndex;
111122
return this;
112123
}
113124

125+
/**
126+
* @return String
127+
*/
114128
public String getSheetName() {
115129
return sheetName;
116130
}
117131

132+
/**
133+
* @param sheetName
134+
* @return Config Config
135+
*/
118136
public Config setSheetName(String sheetName) {
119137
this.sheetName = sheetName;
120138
return this;
@@ -145,7 +163,7 @@ public Integer getContentRowStart() {
145163
/**
146164
* 内容开始行号
147165
*
148-
* @param contentRowStart
166+
* @param contentRowStart contentRowStart
149167
*/
150168
public Config content(Integer contentRowStart) {
151169
this.contentRowStart = contentRowStart;

‎src/main/java/seven/wapperInt/wapperRef/sysWppers/ResWrapperMap.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
//=======================================================
3131

3232
/**
33-
* @author Seven<p>
33+
* @author Seven
3434
*/
3535
@SuppressWarnings({"all"})
3636
public class ResWrapperMap<T> extends WrapperMap<T> {

‎src/main/java/seven/wapperInt/wapperRef/sysWppers/ResWrapperObj.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ protected <T> T refResWrapper(String fs, boolean isMap) throws Exception {
179179

180180
private Class type;
181181

182-
public ResWrapperObj(Class clazz, Consumer<Config> consumer) {
182+
public ResWrapperObj(Class<?> clazz, Consumer<Config> consumer) {
183183
super(consumer);
184184
this.type = clazz;
185185

0 commit comments

Comments
 (0)