Classes

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

Class IconSetManager

Class IconSetManager	Line # 33	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.util.List;
23
24		import org.xwiki.component.annotation.Role;
25
26		/**
27		* Component to get the icon sets from the Wiki instance (from the WAR of from a wiki page).
28		*
29		* @since 6.2M1
30		* @version $Id: c7ccbb02afdbe1c7a247e50c62414cd778937bd9 $
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface IconSetManager
34		{
35		/**
36		* Get the icon set defined in the preferences of the wiki.
37		* @return the current icon set
38		* @throws IconException if problems occur
39		*/
40		IconSet getCurrentIconSet() throws IconException;
41
42		/**
43		* Get the default icon set (from the WAR).
44		* @return the default icon set
45		* @throws IconException if problem occur
46		*/
47		IconSet getDefaultIconSet() throws IconException;
48
49		/**
50		* Get icon set by name.
51		* @param name of the icon set
52		* @return the icon set corresponding to the name, or null if it does not exist
53		* @throws IconException if problem occur
54		*
55		* @since 6.3RC1
56		*/
57		IconSet getIconSet(String name) throws IconException;
58
59		/**
60		* Get the name of all the icon sets present in the current wiki.
61		*
62		* @return the list of the name of the icon sets present in the current wiki.
63		* @throws IconException if problem occur
64		*
65		* @since 6.4M1
66		*/
67		List<String> getIconSetNames() throws IconException;
68		}