AddonManager.java
01 /*
02  * SPDX-License-Identifier: Apache-2.0
03  *
04  * Copyright 2008-2017 the original author or authors.
05  *
06  * Licensed under the Apache License, Version 2.0 (the "License");
07  * you may not use this file except in compliance with the License.
08  * You may obtain a copy of the License at
09  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 package griffon.core.addon;
19 
20 import javax.annotation.Nonnull;
21 import javax.annotation.Nullable;
22 import java.util.Map;
23 
24 /**
25  * Helper class capable of dealing with addons.
26  *
27  @author Andres Almiray
28  @since 2.0.0
29  */
30 public interface AddonManager {
31     void initialize();
32 
33     /**
34      * Returns a read-only view of all available addons
35      *
36      @return a non-null Map of addons keyed by name
37      */
38     @Nonnull
39     Map<String, GriffonAddon> getAddons();
40 
41     /**
42      * Finds an addon by name.<p>
43      * Example: findAddon("miglayout") will return a GriffonAddon that
44      * represents the contributions of the MigLayout plugin.
45      *
46      @param name the name of the addon to search for
47      @return an addon instance if there's a match, null otherwise
48      */
49     @Nullable
50     GriffonAddon findAddon(@Nonnull String name);
51 }