Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
FilterStreamDescriptor	30	0	-	0	0	-1.0 -	Show methods

Class FilterStreamDescriptor

Class FilterStreamDescriptor	Line # 30	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

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
24		/**
25		* Describes a filter stream.
26		*
27		* @version $Id: 4cf9218e9fc6d460eccf27b605b4c5737542aeb8 $
28		* @since 6.2M1
29		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
30		public interface FilterStreamDescriptor
31		{
32		/**
33		* @return human readable name of filter input source type.
34		*/
35		String getName();
36
37		/**
38		* @return the description of the filter
39		*/
40		String getDescription();
41
42		/**
43		* Return descriptor for the provided property name. The property name is not case sensitive.
44		*
45		* @param <T> the type of value associated to this property
46		* @param propertyName the name of the property
47		* @return the descriptor of the property.
48		*/
49		<T> FilterStreamPropertyDescriptor<T> getPropertyDescriptor(String propertyName);
50
51		/**
52		* @return the properties of filter.
53		*/
54		Collection<FilterStreamPropertyDescriptor<?>> getProperties();
55		}