AddonManager.java
01 /*
02  * Copyright 2008-2015 the original author or authors.
03  *
04  * Licensed under the Apache License, Version 2.0 (the "License");
05  * you may not use this file except in compliance with the License.
06  * You may obtain a copy of the License at
07  *
08  *     http://www.apache.org/licenses/LICENSE-2.0
09  *
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 griffon.core.addon;
17 
18 import javax.annotation.Nonnull;
19 import javax.annotation.Nullable;
20 import java.util.Map;
21 
22 /**
23  * Helper class capable of dealing with addons.
24  *
25  @author Andres Almiray
26  @since 2.0.0
27  */
28 public interface AddonManager {
29     void initialize();
30 
31     /**
32      * Returns a read-only view of all available addons
33      *
34      @return a non-null Map of addons keyed by name
35      */
36     @Nonnull
37     Map<String, GriffonAddon> getAddons();
38 
39     /**
40      * Finds an addon by name.<p>
41      * Example: findAddon("miglayout") will return a GriffonAddon that
42      * represents the contributions of the MigLayout plugin.
43      *
44      @param name the name of the addon to search for
45      @return an addon instance if there's a match, null otherwise
46      */
47     @Nullable
48     GriffonAddon findAddon(@Nonnull String name);
49 }