1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.macro.wikibridge

File WikiMacroInitializer.java

 

Code metrics

0
0
0
1
56
9
0
-
-
0
-

Classes

Class Line # Actions
WikiMacroInitializer 31 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.rendering.macro.wikibridge;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Responsible for registering wiki macros against the ComponentManager at XE startup.
26    *
27    * @version $Id: b85cd41c1ffb9454074d1084ac022a914c213c81 $
28    * @since 2.0M2
29    */
30    @Role
 
31    public interface WikiMacroInitializer
32    {
33    /**
34    * Installs or upgrades xwiki classes required for defining wiki macros.
35    *
36    * @throws Exception if an error occurs while installing / upgrading classes.
37    */
38    void installOrUpgradeWikiMacroClasses() throws Exception;
39   
40    /**
41    * Searches for all the wiki macro definitions on the system and registers them against the macro manager.
42    *
43    * @throws Exception if xwiki classes required for defining wiki macros are missing or if an error occurs while
44    * searching for existing wiki macros.
45    */
46    void registerExistingWikiMacros() throws Exception;
47   
48    /**
49    * Searches for all the wiki macro definitions in the specified wiki and registers them against the macro manager.
50    *
51    * @param wiki the name of the wiki to register wiki macros for
52    * @throws Exception if xwiki classes required for defining wiki macros are missing or if an error occurs while
53    * searching for existing wiki macros.
54    */
55    void registerExistingWikiMacros(String wiki) throws Exception;
56    }