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

File FilterDescriptorManager.java

 

Code metrics

0
0
0
1
87
11
0
-
-
0
-

Classes

Class Line # Actions
FilterDescriptorManager 31 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;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Manager {@link FilterDescriptor} related to classes.
26    *
27    * @version $Id: 1661adc427929525aaf6cc5053df02c42abc6d5b $
28    * @since 5.2M1
29    */
30    @Role
 
31    public interface FilterDescriptorManager
32    {
33    /**
34    * @param interfaces the interfaces implemented by the filter
35    * @return the filter descriptor
36    * @since 5.2
37    */
38    FilterDescriptor getFilterDescriptor(Class<?>... interfaces);
39   
40    /**
41    * Helper for input module taking care of calling the right event when it exist, fallback on {@link UnknownFilter}
42    * or simply ignores it when the filter does not support it.
43    *
44    * @param <F> the class of the filter
45    * @param interfaces the interfaces implemented by the filter
46    * @param targetFilter the actual filter to send events to
47    * @return the filter proxy
48    * @since 5.2
49    */
50    <F> F createFilterProxy(Object targetFilter, Class<?>... interfaces);
51   
52    /**
53    * Helper for input module taking care of calling the right event when it exist, fallback on {@link UnknownFilter}
54    * or simply ignores it when the filter does not support it.
55    *
56    * @param <F> the class of the filter
57    * @param interfaces the interfaces implemented by the filter
58    * @param loader the class loader to define the proxy class
59    * @param targetFilter the actual filter to send events to
60    * @return the filter proxy
61    * @since 5.2M3
62    */
63    <F> F createFilterProxy(Object targetFilter, ClassLoader loader, Class<?>... interfaces);
64   
65    /**
66    * Helper for input module taking care of calling the right event when it exist, fallback on {@link UnknownFilter}
67    * or simply ignores it when the filter does not support it.
68    *
69    * @param <F> the class of the filter
70    * @param filters the actual filters to send events to
71    * @return the filter proxy
72    * @since 5.2
73    */
74    <F> F createCompositeFilter(Object... filters);
75   
76    /**
77    * Helper for input module taking care of calling the right event when it exist, fallback on {@link UnknownFilter}
78    * or simply ignores it when the filter does not support it.
79    *
80    * @param <F> the class of the filter
81    * @param filters the actual filters to send events to
82    * @param loader the class loader to define the proxy class
83    * @return the filter proxy
84    * @since 5.2M3
85    */
86    <F> F createCompositeFilter(ClassLoader loader, Object... filters);
87    }