1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.filter.event.extension

File ExtensionFilter.java

 

Code metrics

0
0
0
1
71
15
0
-
-
0
-

Classes

Class Line # Actions
ExtensionFilter 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.filter.event.extension;
21   
22    import org.xwiki.filter.FilterEventParameters;
23    import org.xwiki.filter.FilterException;
24    import org.xwiki.filter.annotation.Default;
25   
26    /**
27    * Extension related events.
28    *
29    * @version $Id: 2a582732c58d2285b885d33efaee9eca7eb3a6d9 $
30    * @since 6.2M1
31    */
 
32    public interface ExtensionFilter
33    {
34    // Properties
35   
36    // Events
37   
38    /**
39    * @param name the name of the namespace
40    * @param parameters the parameters of the namespace
41    * @throws FilterException when failing to send event
42    */
43    void beginNamespace(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
44    throws FilterException;
45   
46    /**
47    * @param name the name of the namespace
48    * @param parameters the parameters of the namespace
49    * @throws FilterException when failing to send event
50    */
51    void endNamespace(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
52    throws FilterException;
53   
54    /**
55    * @param id the id of the extension
56    * @param version the version of the extension
57    * @param parameters the parameters of the extension
58    * @throws FilterException when failing to send event
59    */
60    void beginExtension(String id, String version,
61    @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
62   
63    /**
64    * @param id the id of the extension
65    * @param version the version of the extension
66    * @param parameters the parameters of the extension
67    * @throws FilterException when failing to send event
68    */
69    void endExtension(String id, String version,
70    @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
71    }