1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.listener.chaining

File AbstractChainingListener.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

102
155
53
1
518
429
104
0.67
2.92
53
1.96

Classes

Class Line # Actions
AbstractChainingListener 38 155 0% 104 20
0.935483993.5%
 

Contributing tests

This file is covered by 1462 tests. .

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.listener.chaining;
21   
22    import java.util.Map;
23   
24    import org.xwiki.rendering.listener.Format;
25    import org.xwiki.rendering.listener.HeaderLevel;
26    import org.xwiki.rendering.listener.ListType;
27    import org.xwiki.rendering.listener.MetaData;
28    import org.xwiki.rendering.listener.reference.ResourceReference;
29    import org.xwiki.rendering.syntax.Syntax;
30   
31    /**
32    * Default and basic implementation of a chaining listener that knows how to delegate event calls to the next listener
33    * in the chain.
34    *
35    * @version $Id: c2e1a4a3cc5490d4a35245a2d66b21eeec05097e $
36    * @since 1.8RC1
37    */
 
38    public abstract class AbstractChainingListener implements ChainingListener
39    {
40    /**
41    * The chain to use to know the next listener to call on events.
42    */
43    private ListenerChain listenerChain;
44   
45    /**
46    * @param listenerChain see {@link #getListenerChain()}
47    * @since 2.0M3
48    */
 
49  449956 toggle public void setListenerChain(ListenerChain listenerChain)
50    {
51  449944 this.listenerChain = listenerChain;
52    }
53   
 
54  5324052 toggle @Override
55    public ListenerChain getListenerChain()
56    {
57  5324009 return this.listenerChain;
58    }
59   
 
60  588 toggle @Override
61    public void beginDefinitionDescription()
62    {
63  588 ChainingListener next = getListenerChain().getNextListener(getClass());
64  588 if (next != null) {
65  588 next.beginDefinitionDescription();
66    }
67    }
68   
 
69  338 toggle @Override
70    public void beginDefinitionList(Map<String, String> parameters)
71    {
72  338 ChainingListener next = getListenerChain().getNextListener(getClass());
73  338 if (next != null) {
74  338 next.beginDefinitionList(parameters);
75    }
76    }
77   
 
78  544 toggle @Override
79    public void beginDefinitionTerm()
80    {
81  544 ChainingListener next = getListenerChain().getNextListener(getClass());
82  544 if (next != null) {
83  544 next.beginDefinitionTerm();
84    }
85    }
86   
 
87  131602 toggle @Override
88    public void beginDocument(MetaData metadata)
89    {
90  131604 ChainingListener next = getListenerChain().getNextListener(getClass());
91  131617 if (next != null) {
92  103504 next.beginDocument(metadata);
93    }
94    }
95   
 
96  6504 toggle @Override
97    public void beginGroup(Map<String, String> parameters)
98    {
99  6504 ChainingListener next = getListenerChain().getNextListener(getClass());
100  6504 if (next != null) {
101  6478 next.beginGroup(parameters);
102    }
103    }
104   
 
105  20895 toggle @Override
106    public void beginFormat(Format format, Map<String, String> parameters)
107    {
108  20895 ChainingListener next = getListenerChain().getNextListener(getClass());
109  20895 if (next != null) {
110  20753 next.beginFormat(format, parameters);
111    }
112    }
113   
 
114  2680 toggle @Override
115    public void beginHeader(HeaderLevel level, String id, Map<String, String> parameters)
116    {
117  2680 ChainingListener next = getListenerChain().getNextListener(getClass());
118  2680 if (next != null) {
119  2680 next.beginHeader(level, id, parameters);
120    }
121    }
122   
 
123  4409 toggle @Override
124    public void beginLink(ResourceReference reference, boolean freestanding, Map<String, String> parameters)
125    {
126  4409 ChainingListener next = getListenerChain().getNextListener(getClass());
127  4409 if (next != null) {
128  4264 next.beginLink(reference, freestanding, parameters);
129    }
130    }
131   
 
132  6265 toggle @Override
133    public void beginList(ListType type, Map<String, String> parameters)
134    {
135  6265 ChainingListener next = getListenerChain().getNextListener(getClass());
136  6265 if (next != null) {
137  6265 next.beginList(type, parameters);
138    }
139    }
140   
 
141  18789 toggle @Override
142    public void beginListItem()
143    {
144  18789 ChainingListener next = getListenerChain().getNextListener(getClass());
145  18789 if (next != null) {
146  18789 next.beginListItem();
147    }
148    }
149   
 
150  80492 toggle @Override
151    public void beginMacroMarker(String name, Map<String, String> parameters, String content, boolean isInline)
152    {
153  80493 ChainingListener next = getListenerChain().getNextListener(getClass());
154  80492 if (next != null) {
155  63585 next.beginMacroMarker(name, parameters, content, isInline);
156    }
157    }
158   
 
159  24505 toggle @Override
160    public void beginParagraph(Map<String, String> parameters)
161    {
162  24505 ChainingListener next = getListenerChain().getNextListener(getClass());
163  24505 if (next != null) {
164  24503 next.beginParagraph(parameters);
165    }
166    }
167   
 
168  135 toggle @Override
169    public void beginQuotation(Map<String, String> parameters)
170    {
171  135 ChainingListener next = getListenerChain().getNextListener(getClass());
172  135 if (next != null) {
173  132 next.beginQuotation(parameters);
174    }
175    }
176   
 
177  203 toggle @Override
178    public void beginQuotationLine()
179    {
180  203 ChainingListener next = getListenerChain().getNextListener(getClass());
181  203 if (next != null) {
182  203 next.beginQuotationLine();
183    }
184    }
185   
 
186  3910 toggle @Override
187    public void beginSection(Map<String, String> parameters)
188    {
189  3910 ChainingListener next = getListenerChain().getNextListener(getClass());
190  3910 if (next != null) {
191  3135 next.beginSection(parameters);
192    }
193    }
194   
 
195  394 toggle @Override
196    public void beginTable(Map<String, String> parameters)
197    {
198  394 ChainingListener next = getListenerChain().getNextListener(getClass());
199  394 if (next != null) {
200  394 next.beginTable(parameters);
201    }
202    }
203   
 
204  1500 toggle @Override
205    public void beginTableCell(Map<String, String> parameters)
206    {
207  1500 ChainingListener next = getListenerChain().getNextListener(getClass());
208  1500 if (next != null) {
209  1500 next.beginTableCell(parameters);
210    }
211    }
212   
 
213  750 toggle @Override
214    public void beginTableHeadCell(Map<String, String> parameters)
215    {
216  750 ChainingListener next = getListenerChain().getNextListener(getClass());
217  750 if (next != null) {
218  750 next.beginTableHeadCell(parameters);
219    }
220    }
221   
 
222  925 toggle @Override
223    public void beginTableRow(Map<String, String> parameters)
224    {
225  925 ChainingListener next = getListenerChain().getNextListener(getClass());
226  925 if (next != null) {
227  925 next.beginTableRow(parameters);
228    }
229    }
230   
 
231  4580 toggle @Override
232    public void beginMetaData(MetaData metadata)
233    {
234  4580 ChainingListener next = getListenerChain().getNextListener(getClass());
235  4580 if (next != null) {
236  3624 next.beginMetaData(metadata);
237    }
238    }
239   
 
240  596 toggle @Override
241    public void endDefinitionDescription()
242    {
243  596 ChainingListener next = getListenerChain().getNextListener(getClass());
244  596 if (next != null) {
245  588 next.endDefinitionDescription();
246    }
247    }
248   
 
249  367 toggle @Override
250    public void endDefinitionList(Map<String, String> parameters)
251    {
252  367 ChainingListener next = getListenerChain().getNextListener(getClass());
253  367 if (next != null) {
254  338 next.endDefinitionList(parameters);
255    }
256    }
257   
 
258  552 toggle @Override
259    public void endDefinitionTerm()
260    {
261  552 ChainingListener next = getListenerChain().getNextListener(getClass());
262  552 if (next != null) {
263  544 next.endDefinitionTerm();
264    }
265    }
266   
 
267  132164 toggle @Override
268    public void endDocument(MetaData metadata)
269    {
270  132163 ChainingListener next = getListenerChain().getNextListener(getClass());
271  132178 if (next != null) {
272  104362 next.endDocument(metadata);
273    }
274    }
275   
 
276  6504 toggle @Override
277    public void endGroup(Map<String, String> parameters)
278    {
279  6504 ChainingListener next = getListenerChain().getNextListener(getClass());
280  6504 if (next != null) {
281  6478 next.endGroup(parameters);
282    }
283    }
284   
 
285  20895 toggle @Override
286    public void endFormat(Format format, Map<String, String> parameters)
287    {
288  20895 ChainingListener next = getListenerChain().getNextListener(getClass());
289  20895 if (next != null) {
290  20753 next.endFormat(format, parameters);
291    }
292    }
293   
 
294  2766 toggle @Override
295    public void endHeader(HeaderLevel level, String id, Map<String, String> parameters)
296    {
297  2766 ChainingListener next = getListenerChain().getNextListener(getClass());
298  2766 if (next != null) {
299  2680 next.endHeader(level, id, parameters);
300    }
301    }
302   
 
303  4258 toggle @Override
304    public void endLink(ResourceReference reference, boolean freestanding, Map<String, String> parameters)
305    {
306  4258 ChainingListener next = getListenerChain().getNextListener(getClass());
307  4258 if (next != null) {
308  4258 next.endLink(reference, freestanding, parameters);
309    }
310    }
311   
 
312  6406 toggle @Override
313    public void endList(ListType type, Map<String, String> parameters)
314    {
315  6406 ChainingListener next = getListenerChain().getNextListener(getClass());
316  6406 if (next != null) {
317  6265 next.endList(type, parameters);
318    }
319    }
320   
 
321  18997 toggle @Override
322    public void endListItem()
323    {
324  18997 ChainingListener next = getListenerChain().getNextListener(getClass());
325  18997 if (next != null) {
326  18789 next.endListItem();
327    }
328    }
329   
 
330  80491 toggle @Override
331    public void endMacroMarker(String name, Map<String, String> parameters, String content, boolean isInline)
332    {
333  80493 ChainingListener next = getListenerChain().getNextListener(getClass());
334  80493 if (next != null) {
335  63585 next.endMacroMarker(name, parameters, content, isInline);
336    }
337    }
338   
 
339  29932 toggle @Override
340    public void endParagraph(Map<String, String> parameters)
341    {
342  29932 ChainingListener next = getListenerChain().getNextListener(getClass());
343  29932 if (next != null) {
344  24494 next.endParagraph(parameters);
345    }
346    }
347   
 
348  146 toggle @Override
349    public void endQuotation(Map<String, String> parameters)
350    {
351  146 ChainingListener next = getListenerChain().getNextListener(getClass());
352  146 if (next != null) {
353  132 next.endQuotation(parameters);
354    }
355    }
356   
 
357  231 toggle @Override
358    public void endQuotationLine()
359    {
360  231 ChainingListener next = getListenerChain().getNextListener(getClass());
361  231 if (next != null) {
362  203 next.endQuotationLine();
363    }
364    }
365   
 
366  3910 toggle @Override
367    public void endSection(Map<String, String> parameters)
368    {
369  3910 ChainingListener next = getListenerChain().getNextListener(getClass());
370  3910 if (next != null) {
371  3135 next.endSection(parameters);
372    }
373    }
374   
 
375  427 toggle @Override
376    public void endTable(Map<String, String> parameters)
377    {
378  427 ChainingListener next = getListenerChain().getNextListener(getClass());
379  427 if (next != null) {
380  394 next.endTable(parameters);
381    }
382    }
383   
 
384  1546 toggle @Override
385    public void endTableCell(Map<String, String> parameters)
386    {
387  1546 ChainingListener next = getListenerChain().getNextListener(getClass());
388  1546 if (next != null) {
389  1500 next.endTableCell(parameters);
390    }
391    }
392   
 
393  802 toggle @Override
394    public void endTableHeadCell(Map<String, String> parameters)
395    {
396  802 ChainingListener next = getListenerChain().getNextListener(getClass());
397  802 if (next != null) {
398  750 next.endTableHeadCell(parameters);
399    }
400    }
401   
 
402  988 toggle @Override
403    public void endTableRow(Map<String, String> parameters)
404    {
405  988 ChainingListener next = getListenerChain().getNextListener(getClass());
406  988 if (next != null) {
407  925 next.endTableRow(parameters);
408    }
409    }
410   
 
411  4580 toggle @Override
412    public void endMetaData(MetaData metadata)
413    {
414  4580 ChainingListener next = getListenerChain().getNextListener(getClass());
415  4580 if (next != null) {
416  3624 next.endMetaData(metadata);
417    }
418    }
419   
 
420  856 toggle @Override
421    public void onEmptyLines(int count)
422    {
423  856 ChainingListener next = getListenerChain().getNextListener(getClass());
424  856 if (next != null) {
425  856 next.onEmptyLines(count);
426    }
427    }
428   
 
429  116 toggle @Override
430    public void onHorizontalLine(Map<String, String> parameters)
431    {
432  116 ChainingListener next = getListenerChain().getNextListener(getClass());
433  116 if (next != null) {
434  116 next.onHorizontalLine(parameters);
435    }
436    }
437   
 
438  39 toggle @Override
439    public void onId(String name)
440    {
441  39 ChainingListener next = getListenerChain().getNextListener(getClass());
442  39 if (next != null) {
443  39 next.onId(name);
444    }
445    }
446   
 
447  2328 toggle @Override
448    public void onImage(ResourceReference reference, boolean freestanding, Map<String, String> parameters)
449    {
450  2328 ChainingListener next = getListenerChain().getNextListener(getClass());
451  2328 if (next != null) {
452  2328 next.onImage(reference, freestanding, parameters);
453    }
454    }
455   
 
456  1784 toggle @Override
457    public void onMacro(String id, Map<String, String> parameters, String content, boolean inline)
458    {
459  1784 ChainingListener next = getListenerChain().getNextListener(getClass());
460  1784 if (next != null) {
461  1384 next.onMacro(id, parameters, content, inline);
462    }
463    }
464   
 
465  32606 toggle @Override
466    public void onNewLine()
467    {
468  32606 ChainingListener next = getListenerChain().getNextListener(getClass());
469  32606 if (next != null) {
470  32606 next.onNewLine();
471    }
472    }
473   
 
474  1333572 toggle @Override
475    public void onSpace()
476    {
477  1333574 ChainingListener next = getListenerChain().getNextListener(getClass());
478  1333588 if (next != null) {
479  1333586 next.onSpace();
480    }
481    }
482   
 
483  1120296 toggle @Override
484    public void onSpecialSymbol(char symbol)
485    {
486  1120295 ChainingListener next = getListenerChain().getNextListener(getClass());
487  1120313 if (next != null) {
488  1120313 next.onSpecialSymbol(symbol);
489    }
490    }
491   
 
492  448 toggle @Override
493    public void onVerbatim(String content, boolean inline, Map<String, String> parameters)
494    {
495  448 ChainingListener next = getListenerChain().getNextListener(getClass());
496  448 if (next != null) {
497  448 next.onVerbatim(content, inline, parameters);
498    }
499    }
500   
 
501  1453070 toggle @Override
502    public void onWord(String word)
503    {
504  1453072 ChainingListener next = getListenerChain().getNextListener(getClass());
505  1453104 if (next != null) {
506  1453103 next.onWord(word);
507    }
508    }
509   
 
510  26787 toggle @Override
511    public void onRawText(String text, Syntax syntax)
512    {
513  26787 ChainingListener next = getListenerChain().getNextListener(getClass());
514  26787 if (next != null) {
515  26783 next.onRawText(text, syntax);
516    }
517    }
518    }