|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+package com.chinaitop.agile.utils;
|
|
|
2
|
+import java.text.SimpleDateFormat;
|
|
|
3
|
+import java.util.Date;
|
|
|
4
|
+import java.util.Properties;
|
|
|
5
|
+
|
|
|
6
|
+import static org.mybatis.generator.internal.util.StringUtility.isTrue;
|
|
|
7
|
+import org.mybatis.generator.api.CommentGenerator;
|
|
|
8
|
+import org.mybatis.generator.api.IntrospectedColumn;
|
|
|
9
|
+import org.mybatis.generator.api.IntrospectedTable;
|
|
|
10
|
+import org.mybatis.generator.api.dom.java.CompilationUnit;
|
|
|
11
|
+import org.mybatis.generator.api.dom.java.Field;
|
|
|
12
|
+import org.mybatis.generator.api.dom.java.InnerClass;
|
|
|
13
|
+import org.mybatis.generator.api.dom.java.InnerEnum;
|
|
|
14
|
+import org.mybatis.generator.api.dom.java.JavaElement;
|
|
|
15
|
+import org.mybatis.generator.api.dom.java.Method;
|
|
|
16
|
+import org.mybatis.generator.api.dom.java.Parameter;
|
|
|
17
|
+import org.mybatis.generator.api.dom.xml.XmlElement;
|
|
|
18
|
+import org.mybatis.generator.config.MergeConstants;
|
|
|
19
|
+import org.mybatis.generator.config.PropertyRegistry;
|
|
|
20
|
+
|
|
|
21
|
+public class MyCommentGenerator implements CommentGenerator {
|
|
|
22
|
+
|
|
|
23
|
+ private Properties properties;
|
|
|
24
|
+ private Properties systemPro;
|
|
|
25
|
+ private boolean suppressDate;
|
|
|
26
|
+ private boolean suppressAllComments;
|
|
|
27
|
+ private String currentDateStr;
|
|
|
28
|
+
|
|
|
29
|
+ public MyCommentGenerator() {
|
|
|
30
|
+ super();
|
|
|
31
|
+ properties = new Properties();
|
|
|
32
|
+ systemPro = System.getProperties();
|
|
|
33
|
+ suppressDate = false;
|
|
|
34
|
+ suppressAllComments = false;
|
|
|
35
|
+ currentDateStr = (new SimpleDateFormat("yyyy-MM-dd")).format(new Date());
|
|
|
36
|
+ }
|
|
|
37
|
+
|
|
|
38
|
+
|
|
|
39
|
+ @Override
|
|
|
40
|
+ public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable) {
|
|
|
41
|
+ if (suppressAllComments) {
|
|
|
42
|
+ return;
|
|
|
43
|
+ }
|
|
|
44
|
+ StringBuilder sb = new StringBuilder();
|
|
|
45
|
+ innerClass.addJavaDocLine("/**");
|
|
|
46
|
+ sb.append(" * ");
|
|
|
47
|
+ sb.append(introspectedTable.getFullyQualifiedTable());
|
|
|
48
|
+ sb.append(" ");
|
|
|
49
|
+ sb.append(getDateString());
|
|
|
50
|
+ innerClass.addJavaDocLine(sb.toString());
|
|
|
51
|
+ innerClass.addJavaDocLine(" */");
|
|
|
52
|
+
|
|
|
53
|
+ }
|
|
|
54
|
+
|
|
|
55
|
+ @Override
|
|
|
56
|
+ public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean arg2) {
|
|
|
57
|
+ if (suppressAllComments) {
|
|
|
58
|
+ return;
|
|
|
59
|
+ }
|
|
|
60
|
+
|
|
|
61
|
+ StringBuilder sb = new StringBuilder();
|
|
|
62
|
+
|
|
|
63
|
+ innerClass.addJavaDocLine("/**");
|
|
|
64
|
+ sb.append(" * ");
|
|
|
65
|
+ sb.append(introspectedTable.getFullyQualifiedTable());
|
|
|
66
|
+ innerClass.addJavaDocLine(sb.toString());
|
|
|
67
|
+
|
|
|
68
|
+ sb.setLength(0);
|
|
|
69
|
+ sb.append(" * @author ");
|
|
|
70
|
+ sb.append(systemPro.getProperty("user.name"));
|
|
|
71
|
+ sb.append(" ");
|
|
|
72
|
+ sb.append(currentDateStr);
|
|
|
73
|
+
|
|
|
74
|
+ // addJavadocTag(innerClass, markAsDoNotDelete);
|
|
|
75
|
+
|
|
|
76
|
+ innerClass.addJavaDocLine(" */");
|
|
|
77
|
+
|
|
|
78
|
+ }
|
|
|
79
|
+
|
|
|
80
|
+ @Override
|
|
|
81
|
+ public void addComment(XmlElement arg0) {
|
|
|
82
|
+ return;
|
|
|
83
|
+ }
|
|
|
84
|
+
|
|
|
85
|
+ @Override
|
|
|
86
|
+ public void addConfigurationProperties(Properties properties) {
|
|
|
87
|
+ this.properties.putAll(properties);
|
|
|
88
|
+
|
|
|
89
|
+ suppressDate = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_DATE));
|
|
|
90
|
+
|
|
|
91
|
+ suppressAllComments = isTrue(properties.getProperty(PropertyRegistry.COMMENT_GENERATOR_SUPPRESS_ALL_COMMENTS));
|
|
|
92
|
+
|
|
|
93
|
+ }
|
|
|
94
|
+
|
|
|
95
|
+ /**
|
|
|
96
|
+ * This method adds the custom javadoc tag for. You may do nothing if you do
|
|
|
97
|
+ * not wish to include the Javadoc tag - however, if you do not include the
|
|
|
98
|
+ * Javadoc tag then the Java merge capability of the eclipse plugin will
|
|
|
99
|
+ * break.
|
|
|
100
|
+ *
|
|
|
101
|
+ * @param javaElement
|
|
|
102
|
+ * the java element
|
|
|
103
|
+ */
|
|
|
104
|
+ protected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete) {
|
|
|
105
|
+ javaElement.addJavaDocLine(" *");
|
|
|
106
|
+ StringBuilder sb = new StringBuilder();
|
|
|
107
|
+ sb.append(" * ");
|
|
|
108
|
+ sb.append(MergeConstants.NEW_ELEMENT_TAG);
|
|
|
109
|
+ if (markAsDoNotDelete) {
|
|
|
110
|
+ sb.append(" do_not_delete_during_merge");
|
|
|
111
|
+ }
|
|
|
112
|
+ String s = getDateString();
|
|
|
113
|
+ if (s != null) {
|
|
|
114
|
+ sb.append(' ');
|
|
|
115
|
+ sb.append(s);
|
|
|
116
|
+ }
|
|
|
117
|
+ javaElement.addJavaDocLine(sb.toString());
|
|
|
118
|
+ }
|
|
|
119
|
+
|
|
|
120
|
+ protected String getDateString() {
|
|
|
121
|
+ String result = null;
|
|
|
122
|
+ if (!suppressDate) {
|
|
|
123
|
+ result = currentDateStr;
|
|
|
124
|
+ }
|
|
|
125
|
+ return result;
|
|
|
126
|
+ }
|
|
|
127
|
+
|
|
|
128
|
+
|
|
|
129
|
+ @Override
|
|
|
130
|
+ public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable) {
|
|
|
131
|
+ if (suppressAllComments) {
|
|
|
132
|
+ return;
|
|
|
133
|
+ }
|
|
|
134
|
+
|
|
|
135
|
+ StringBuilder sb = new StringBuilder();
|
|
|
136
|
+
|
|
|
137
|
+ innerEnum.addJavaDocLine("/**");
|
|
|
138
|
+ // addJavadocTag(innerEnum, false);
|
|
|
139
|
+ sb.append(" * ");
|
|
|
140
|
+ sb.append(introspectedTable.getFullyQualifiedTable());
|
|
|
141
|
+ innerEnum.addJavaDocLine(sb.toString());
|
|
|
142
|
+ innerEnum.addJavaDocLine(" */");
|
|
|
143
|
+
|
|
|
144
|
+ }
|
|
|
145
|
+
|
|
|
146
|
+ @Override
|
|
|
147
|
+ public void addFieldComment(Field field, IntrospectedTable introspectedTable) {
|
|
|
148
|
+ if (suppressAllComments) {
|
|
|
149
|
+ return;
|
|
|
150
|
+ }
|
|
|
151
|
+
|
|
|
152
|
+ StringBuilder sb = new StringBuilder();
|
|
|
153
|
+
|
|
|
154
|
+ field.addJavaDocLine("/**");
|
|
|
155
|
+ sb.append(" * ");
|
|
|
156
|
+ sb.append(introspectedTable.getFullyQualifiedTable());
|
|
|
157
|
+ field.addJavaDocLine(sb.toString());
|
|
|
158
|
+ field.addJavaDocLine(" */");
|
|
|
159
|
+
|
|
|
160
|
+ }
|
|
|
161
|
+
|
|
|
162
|
+ @Override
|
|
|
163
|
+ public void addFieldComment(Field arg0, IntrospectedTable arg1, IntrospectedColumn arg2) {
|
|
|
164
|
+ // TODO Auto-generated method stub
|
|
|
165
|
+
|
|
|
166
|
+ }
|
|
|
167
|
+
|
|
|
168
|
+ @Override
|
|
|
169
|
+ public void addGeneralMethodComment(Method arg0, IntrospectedTable arg1) {
|
|
|
170
|
+ if (suppressAllComments) {
|
|
|
171
|
+ return;
|
|
|
172
|
+ }
|
|
|
173
|
+ // method.addJavaDocLine("/**");
|
|
|
174
|
+ // addJavadocTag(method, false);
|
|
|
175
|
+ // method.addJavaDocLine(" */");
|
|
|
176
|
+
|
|
|
177
|
+ }
|
|
|
178
|
+
|
|
|
179
|
+ @Override
|
|
|
180
|
+ public void addGetterComment(Method method, IntrospectedTable arg1, IntrospectedColumn introspectedColumn) {
|
|
|
181
|
+ if (suppressAllComments) {
|
|
|
182
|
+ return;
|
|
|
183
|
+ }
|
|
|
184
|
+
|
|
|
185
|
+ method.addJavaDocLine("/**");
|
|
|
186
|
+
|
|
|
187
|
+ StringBuilder sb = new StringBuilder();
|
|
|
188
|
+ sb.append(" * ");
|
|
|
189
|
+ sb.append(introspectedColumn.getRemarks());
|
|
|
190
|
+ method.addJavaDocLine(sb.toString());
|
|
|
191
|
+
|
|
|
192
|
+ sb.setLength(0);
|
|
|
193
|
+ sb.append(" * @return ");
|
|
|
194
|
+ sb.append(introspectedColumn.getActualColumnName());
|
|
|
195
|
+ sb.append(" ");
|
|
|
196
|
+ sb.append(introspectedColumn.getRemarks());
|
|
|
197
|
+ method.addJavaDocLine(sb.toString());
|
|
|
198
|
+
|
|
|
199
|
+ // addJavadocTag(method, false);
|
|
|
200
|
+
|
|
|
201
|
+ method.addJavaDocLine(" */");
|
|
|
202
|
+
|
|
|
203
|
+ }
|
|
|
204
|
+
|
|
|
205
|
+ @Override
|
|
|
206
|
+ public void addJavaFileComment(CompilationUnit arg0) {
|
|
|
207
|
+ return;
|
|
|
208
|
+ }
|
|
|
209
|
+
|
|
|
210
|
+ @Override
|
|
|
211
|
+ public void addRootComment(XmlElement arg0) {
|
|
|
212
|
+ return;
|
|
|
213
|
+ }
|
|
|
214
|
+
|
|
|
215
|
+ @Override
|
|
|
216
|
+ public void addSetterComment(Method method, IntrospectedTable arg1, IntrospectedColumn introspectedColumn) {
|
|
|
217
|
+ if (suppressAllComments) {
|
|
|
218
|
+ return;
|
|
|
219
|
+ }
|
|
|
220
|
+
|
|
|
221
|
+
|
|
|
222
|
+ method.addJavaDocLine("/**");
|
|
|
223
|
+ StringBuilder sb = new StringBuilder();
|
|
|
224
|
+ sb.append(" * ");
|
|
|
225
|
+ sb.append(introspectedColumn.getRemarks());
|
|
|
226
|
+ method.addJavaDocLine(sb.toString());
|
|
|
227
|
+
|
|
|
228
|
+ Parameter parm = method.getParameters().get(0);
|
|
|
229
|
+ sb.setLength(0);
|
|
|
230
|
+ sb.append(" * @param ");
|
|
|
231
|
+ sb.append(parm.getName());
|
|
|
232
|
+ sb.append(" ");
|
|
|
233
|
+ sb.append(introspectedColumn.getRemarks());
|
|
|
234
|
+ method.addJavaDocLine(sb.toString());
|
|
|
235
|
+
|
|
|
236
|
+ // addJavadocTag(method, false);
|
|
|
237
|
+
|
|
|
238
|
+ method.addJavaDocLine(" */");
|
|
|
239
|
+
|
|
|
240
|
+ }
|
|
|
241
|
+
|
|
|
242
|
+}
|