1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.filter.descriptor

File AbstractFilterStreamDescriptor.java

 

Coverage histogram

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

Code metrics

0
6
5
1
88
38
5
0.83
1.2
5
1

Classes

Class Line # Actions
AbstractFilterStreamDescriptor 31 6 0% 5 0
1.0100%
 

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.descriptor;
21   
22    import java.util.Collection;
23    import java.util.Collections;
24    import java.util.LinkedHashMap;
25    import java.util.Map;
26   
27    /**
28    * @version $Id: 2cb63098867439a763bd80d12874ebb541806ba5 $
29    * @since 6.2M1
30    */
 
31    public abstract class AbstractFilterStreamDescriptor implements FilterStreamDescriptor
32    {
33    /**
34    * @see #getName()
35    */
36    protected String name;
37   
38    /**
39    * The description of the macro.
40    */
41    protected String description;
42   
43    /**
44    * A map containing the {@link FilterStreamPropertyDescriptor} for each parameters supported for this filter.
45    * <p>
46    * The {@link Map} keys are lower cased for easier case insensitive search, to get the "real" name of the property
47    * use {@link FilterStreamPropertyDescriptor#getName()}.
48    */
49    protected Map<String, FilterStreamPropertyDescriptor<?>> parameterDescriptorMap =
50    new LinkedHashMap<String, FilterStreamPropertyDescriptor<?>>();
51   
52    /**
53    * @param name human readable name of filter input source type.
54    * @param description the description of the filter
55    */
 
56  1091 toggle public AbstractFilterStreamDescriptor(String name, String description)
57    {
58  1091 this.name = name;
59  1091 this.description = description;
60    }
61   
62    // FilterDescriptor
63   
 
64  44 toggle @Override
65    public String getName()
66    {
67  44 return this.name;
68    }
69   
 
70  20 toggle @Override
71    public String getDescription()
72    {
73  20 return this.description;
74    }
75   
 
76  49 toggle @Override
77    public <T> FilterStreamPropertyDescriptor<T> getPropertyDescriptor(String propertyName)
78    {
79  49 return (FilterStreamPropertyDescriptor<T>) this.parameterDescriptorMap.get(propertyName);
80    }
81   
 
82  60 toggle @Override
83    public Collection<FilterStreamPropertyDescriptor<?>> getProperties()
84    {
85  60 return Collections.<FilterStreamPropertyDescriptor<?>>unmodifiableCollection(this.parameterDescriptorMap
86    .values());
87    }
88    }