Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
CoreExtensionRepository | 38 | 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.extension.repository; | |
21 | ||
22 | import java.util.Collection; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.extension.CoreExtension; | |
26 | import org.xwiki.extension.ExtensionDependency; | |
27 | import org.xwiki.extension.ExtensionId; | |
28 | import org.xwiki.extension.ResolveException; | |
29 | import org.xwiki.extension.repository.search.AdvancedSearchable; | |
30 | ||
31 | /** | |
32 | * Virtual extension repository containing core extensions. | |
33 | * | |
34 | * @version $Id: f8efd8bc11d44955d6202516949da59c548bc250 $ | |
35 | * @since 4.0M1 | |
36 | */ | |
37 | @Role | |
38 | public interface CoreExtensionRepository extends ExtensionRepository, AdvancedSearchable | |
39 | { | |
40 | /** | |
41 | * @return the number of core extensions | |
42 | */ | |
43 | int countExtensions(); | |
44 | ||
45 | /** | |
46 | * @return all the core extensions | |
47 | */ | |
48 | Collection<CoreExtension> getCoreExtensions(); | |
49 | ||
50 | /** | |
51 | * Return the extension corresponding to the current environment if any. Generally used to get the current XWiki | |
52 | * distribution. | |
53 | * | |
54 | * @return the core extension associated to the environment | |
55 | */ | |
56 | CoreExtension getEnvironmentExtension(); | |
57 | ||
58 | /** | |
59 | * @param feature the feature provided by the extension including its identifier (version is not needed since there | |
60 | * can be only one version of a core extension) | |
61 | * @return the core extension, null if none is found | |
62 | */ | |
63 | CoreExtension getCoreExtension(String feature); | |
64 | ||
65 | /** | |
66 | * @param feature the feature provided by the extension including its identifier (version is not needed since there | |
67 | * can be only one version of a core extension) | |
68 | * @return true if the extension exists, false otherwise | |
69 | */ | |
70 | boolean exists(String feature); | |
71 | ||
72 | // ExtensionRepository | |
73 | ||
74 | @Override | |
75 | CoreExtension resolve(ExtensionDependency extensionDependency) throws ResolveException; | |
76 | ||
77 | @Override | |
78 | CoreExtension resolve(ExtensionId extensionId) throws ResolveException; | |
79 | } |