1 /*
2 * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.testdoc.report.resource;
17
18 import java.util.Locale;
19
20 import org.apache.commons.lang.NullArgumentException;
21
22 /**
23 * Provides access to category resources.
24 *
25 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
26 * @version $Revision:591 $
27 */
28 public interface CategoryResourceProvider
29 {
30 // ********************************* Fields *********************************
31
32 // --- constants ------------------------------------------------------------
33
34 // ****************************** Initializer *******************************
35
36 // ****************************** Inner Classes *****************************
37
38 // ********************************* Methods ********************************
39
40 // --- get&set --------------------------------------------------------------
41
42 // --- business -------------------------------------------------------------
43
44 /**
45 * Returns the category resource for the given category type.
46 *
47 * @param locale the locale for which the resource is requested.
48 * @param categoryType the type of the category the resource is requested.
49 * @return a category resource, <code>null</code> if the resource is not
50 * provided by this instance.
51 * @throws NullArgumentException if either <code>locale</code> or
52 * <code>categoryType</code> is <code>null</code>.
53 * @throws IconNotFoundException if an icon has been referenced, but was
54 * not found at the specified location.
55 */
56 CategoryResource getResource(Locale locale, Class<?> categoryType)
57 throws NullArgumentException, IconNotFoundException;
58
59 // --- object basics --------------------------------------------------------
60
61 }