1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.component.internal.multi

File ComponentManagerFactory.java

 

Code metrics

0
0
0
1
56
9
0
-
-
0
-

Classes

Class Line # Actions
ComponentManagerFactory 39 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.component.internal.multi;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.component.manager.ComponentManager;
24   
25    /**
26    * Return {@link ComponentManager} implementations. If you want to implement your own version of component manager
27    * handling for XWiki you'd need to implement this interface. This is the top level interface used to configure XWiki's
28    * component system. For example:
29    * <code><pre>
30    * ComponentManagerFactory factory = new EmbeddableComponentManagerFactory();
31    * ComponentAnnotationLoader loader = new ComponentAnnotationLoader();
32    * loader.initialize(factory.createComponentManager(), classLoader);
33    * </pre></code>
34    *
35    * @version $Id: 44596d7d867a9ae839bac9f7c079432d78c25ec6 $
36    * @since 3.3M2
37    */
38    @Role
 
39    public interface ComponentManagerFactory
40    {
41    /**
42    * @param parentComponentManager the parent Component Manager of the Component Manager to create. Can be null to
43    * create a Root Component Manager. See also {@link ComponentManager#getParent()}
44    * @return a {@link ComponentManager} implementation
45    */
46    ComponentManager createComponentManager(ComponentManager parentComponentManager);
47   
48    /**
49    * @param namespace the namespace associated to the new {@link ComponentManager}
50    * @param parentComponentManager the parent Component Manager of the Component Manager to create. Can be null to
51    * create a Root Component Manager. See also {@link ComponentManager#getParent()}
52    * @return a {@link ComponentManager} implementation
53    * @since 6.4M2
54    */
55    ComponentManager createComponentManager(String namespace, ComponentManager parentComponentManager);
56    }