Classes

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

Class IconSetLoader

Class IconSetLoader	Line # 34	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.icon;
21
22		import java.io.Reader;
23
24		import org.xwiki.component.annotation.Role;
25		import org.xwiki.model.reference.DocumentReference;
26
27		/**
28		* Component to load an IconSet.
29		*
30		* @since 6.2M1
31		* @version $Id: ac73a14c48fa2b5dff427ec7a57856daf77ccbe1 $
32		*/
33		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
34		public interface IconSetLoader
35		{
36		/**
37		* Load an icon set from a document in the wiki.
38		* @param iconSetReference reference to the document holding the icon set
39		* @return the loaded icon set
40		* @throws IconException if problems occur
41		*/
42		IconSet loadIconSet(DocumentReference iconSetReference) throws IconException;
43
44		/**
45		* Load an icon set from any string input.
46		* @param input string that describes an icon set
47		* @param name name of the icon set to load
48		* @return the loaded icon set
49		* @throws IconException if problems occur
50		*/
51		IconSet loadIconSet(Reader input, String name) throws IconException;
52		}