Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
Resource | 29 | 0 | - | 0 | 0 |
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.skin; | |
21 | ||
22 | import org.xwiki.filter.input.InputSource; | |
23 | ||
24 | /** | |
25 | * @param <I> the type of the {@link InputSource} | |
26 | * @version $Id: abc054c011c7b51b5d5da4312a8eafd07f050200 $ | |
27 | * @since 7.0M1 | |
28 | */ | |
29 | public interface Resource<I extends InputSource> | |
30 | { | |
31 | /** | |
32 | * @return the repository containing the resource | |
33 | */ | |
34 | ResourceRepository getRepository(); | |
35 | ||
36 | /** | |
37 | * @return the unique identifier of the resource | |
38 | */ | |
39 | String getId(); | |
40 | ||
41 | /** | |
42 | * @return the path of the resource | |
43 | */ | |
44 | String getPath(); | |
45 | ||
46 | /** | |
47 | * @return the name of the resource (usually a relative path) | |
48 | * @since 8.3RC1 | |
49 | */ | |
50 | String getResourceName(); | |
51 | ||
52 | /** | |
53 | * Provide an {@link InputSource} to read the resource. | |
54 | * | |
55 | * @return an {@link InputSource} to read the resource | |
56 | * @throws Exception when failing to create a {@link InputSource} for the resource | |
57 | */ | |
58 | I getInputSource() throws Exception; | |
59 | ||
60 | /** | |
61 | * Create a URL for the resource. | |
62 | * | |
63 | * @param forceSkinAction true if a dynamic skin URL should be forced | |
64 | * @return a URL to the resource | |
65 | * @throws Exception when failing to create a URL for the resource | |
66 | */ | |
67 | String getURL(boolean forceSkinAction) throws Exception; | |
68 | } |