1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package org.xwiki.filter.event.model; |
21 |
|
|
22 |
|
import java.util.Locale; |
23 |
|
|
24 |
|
import org.slf4j.Marker; |
25 |
|
import org.slf4j.MarkerFactory; |
26 |
|
import org.xwiki.filter.FilterEventParameters; |
27 |
|
import org.xwiki.filter.FilterException; |
28 |
|
import org.xwiki.filter.annotation.Default; |
29 |
|
|
30 |
|
|
31 |
|
|
32 |
|
|
33 |
|
@version |
34 |
|
@since |
35 |
|
|
|
|
| - |
Uncovered Elements: 0 (0) |
Complexity: 0 |
Complexity Density: - |
|
36 |
|
public interface WikiDocumentFilter |
37 |
|
{ |
38 |
|
|
39 |
|
|
40 |
|
|
41 |
|
|
42 |
|
@link |
43 |
|
|
44 |
|
@since |
45 |
|
|
46 |
|
Marker LOG_DOCUMENT_CREATED = MarkerFactory.getMarker("filter.document.created"); |
47 |
|
|
48 |
|
|
49 |
|
|
50 |
|
@link |
51 |
|
|
52 |
|
@since |
53 |
|
|
54 |
|
Marker LOG_DOCUMENT_UPDATED = MarkerFactory.getMarker("filter.document.updated"); |
55 |
|
|
56 |
|
|
57 |
|
|
58 |
|
@link |
59 |
|
|
60 |
|
@since |
61 |
|
|
62 |
|
Marker LOG_DOCUMENT_DELETED = MarkerFactory.getMarker("filter.document.deleted"); |
63 |
|
|
64 |
|
|
65 |
|
|
66 |
|
@link |
67 |
|
|
68 |
|
@since |
69 |
|
|
70 |
|
Marker LOG_DOCUMENT_SKIPPED = MarkerFactory.getMarker("filter.document.skipped"); |
71 |
|
|
72 |
|
|
73 |
|
|
74 |
|
@link |
75 |
|
|
76 |
|
@since |
77 |
|
|
78 |
|
Marker LOG_DOCUMENT_ERROR = MarkerFactory.getMarker("filter.document.error"); |
79 |
|
|
80 |
|
|
81 |
|
|
82 |
|
|
83 |
|
@link |
84 |
|
|
85 |
|
String PARAMETER_SYNTAX = "syntax"; |
86 |
|
|
87 |
|
|
88 |
|
@link |
89 |
|
|
90 |
|
String PARAMETER_PARENT = "parent_reference"; |
91 |
|
|
92 |
|
|
93 |
|
@link |
94 |
|
|
95 |
|
String PARAMETER_TITLE = "title"; |
96 |
|
|
97 |
|
|
98 |
|
@link |
99 |
|
|
100 |
|
String PARAMETER_HIDDEN = "hidden"; |
101 |
|
|
102 |
|
|
103 |
|
@link |
104 |
|
|
105 |
|
String PARAMETER_CUSTOMCLASS = "customclass"; |
106 |
|
|
107 |
|
|
108 |
|
@link |
109 |
|
|
110 |
|
String PARAMETER_DEFAULTTEMPLATE = "defaulttemplate"; |
111 |
|
|
112 |
|
|
113 |
|
@link |
114 |
|
|
115 |
|
String PARAMETER_VALIDATIONSCRIPT = "validationscript"; |
116 |
|
|
117 |
|
|
118 |
|
|
119 |
|
|
120 |
|
@link |
121 |
|
|
122 |
|
String PARAMETER_CONTENT = "content"; |
123 |
|
|
124 |
|
|
125 |
|
@link |
126 |
|
|
127 |
|
String PARAMETER_CONTENT_HTML = "content_html"; |
128 |
|
|
129 |
|
|
130 |
|
@link |
131 |
|
|
132 |
|
String PARAMETER_CONTENT_AUTHOR = "content_author"; |
133 |
|
|
134 |
|
|
135 |
|
@link |
136 |
|
|
137 |
|
String PARAMETER_CONTENT_DATE = "content_date"; |
138 |
|
|
139 |
|
|
140 |
|
|
141 |
|
|
142 |
|
@link |
143 |
|
|
144 |
|
String PARAMETER_CREATION_AUTHOR = "creation_author"; |
145 |
|
|
146 |
|
|
147 |
|
@link |
148 |
|
|
149 |
|
String PARAMETER_CREATION_DATE = "creation_date"; |
150 |
|
|
151 |
|
|
152 |
|
|
153 |
|
|
154 |
|
@link |
155 |
|
|
156 |
|
String PARAMETER_LOCALE = "locale"; |
157 |
|
|
158 |
|
|
159 |
|
|
160 |
|
|
161 |
|
@link |
162 |
|
@since |
163 |
|
|
164 |
|
String PARAMETER_LASTREVISION = "lastrevision"; |
165 |
|
|
166 |
|
|
167 |
|
@link |
168 |
|
|
169 |
|
String PARAMETER_REVISION_DATE = "revision_date"; |
170 |
|
|
171 |
|
|
172 |
|
@link |
173 |
|
|
174 |
|
String PARAMETER_REVISION_AUTHOR = "revision_author"; |
175 |
|
|
176 |
|
|
177 |
|
@link |
178 |
|
|
179 |
|
String PARAMETER_REVISION_COMMENT = "revision_comment"; |
180 |
|
|
181 |
|
|
182 |
|
@link |
183 |
|
|
184 |
|
String PARAMETER_REVISION_MINOR = "revision_minor"; |
185 |
|
|
186 |
|
|
187 |
|
|
188 |
|
|
189 |
|
@param |
190 |
|
@param |
191 |
|
@throws |
192 |
|
|
193 |
|
void beginWikiDocument(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) |
194 |
|
throws FilterException; |
195 |
|
|
196 |
|
|
197 |
|
@param |
198 |
|
@param |
199 |
|
@throws |
200 |
|
|
201 |
|
void endWikiDocument(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) |
202 |
|
throws FilterException; |
203 |
|
|
204 |
|
|
205 |
|
@param |
206 |
|
@param |
207 |
|
@throws |
208 |
|
|
209 |
|
void beginWikiDocumentLocale(@Default("") Locale locale, |
210 |
|
@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException; |
211 |
|
|
212 |
|
|
213 |
|
@param |
214 |
|
@param |
215 |
|
@throws |
216 |
|
|
217 |
|
void endWikiDocumentLocale(@Default("") Locale locale, |
218 |
|
@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException; |
219 |
|
|
220 |
|
|
221 |
|
@param |
222 |
|
@param |
223 |
|
@throws |
224 |
|
|
225 |
|
void beginWikiDocumentRevision(String revision, |
226 |
|
@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException; |
227 |
|
|
228 |
|
|
229 |
|
@param |
230 |
|
@param |
231 |
|
@throws |
232 |
|
|
233 |
|
void endWikiDocumentRevision(String revision, |
234 |
|
@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException; |
235 |
|
} |