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

File UIExtensionFilter.java

 

Code metrics

0
0
0
1
44
8
0
-
-
0
-

Classes

Class Line # Actions
UIExtensionFilter 33 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.uiextension;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * A UIExtensionFilter provides a way to filter a list of {@link UIExtension}.
28    *
29    * @version $Id: 81de495a2928dafffa08f1e5b8effcfc0e598317 $
30    * @since 4.3M1
31    */
32    @Role
 
33    public interface UIExtensionFilter
34    {
35    /**
36    * Filter a list of {@link UIExtension}. Some filters require information provided by the user of the API, since we
37    * don't support Constructor or setter injection we need the "parameter" argument to pass information to the filter.
38    *
39    * @param extensions The list of {@link UIExtension}s to filter
40    * @param parameters A list of optional parameters
41    * @return The filtered list
42    */
43    List<UIExtension> filter(List<UIExtension> extensions, String... parameters);
44    }