Clover Coverage Report - XWiki Rendering - Parent POM 4.0-SNAPSHOT (Aggregated)
Coverage timestamp: Mon Mar 12 2012 18:03:13 CET
0   47   0   -
0   6   -   0
0     -  
1    
 
  BlockFilter       Line # 38 0 - 0 0 - -1.0
 
No Tests
 
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.block;
21   
22    import java.util.List;
23   
24    /**
25    * Filter provided block into one or more block.
26    * <p>
27    * The block filter is generally called for each block in a block list and is asked to return a filtered version of the
28    * provided block. This means:
29    * <ul>
30    * <li>an empty list if the block as to be removed</li>
31    * <li>the block itself in a list if the filter does not have anything particular to filter on it</li>
32    * <li>or even a list of new block to replace the provided block</li>
33    * </ul>
34    *
35    * @version $Id$
36    * @since 1.8RC2
37    */
 
38    public interface BlockFilter
39    {
40    /**
41    * Filter provided block into zero or more block.
42    *
43    * @param block the block to filter.
44    * @return should never be null. The filtered blocks or empty list.
45    */
46    List<Block> filter(Block block);
47    }