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

File MacroCategoryManager.java

 

Code metrics

0
0
0
1
76
12
0
-
-
0
-

Classes

Class Line # Actions
MacroCategoryManager 36 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;
21   
22    import java.util.Set;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.rendering.syntax.Syntax;
26   
27    /**
28    * Component interface for managing macro category information. Each rendering macro defines a default category under
29    * which it falls, but this category may be overwritten by xwiki configuration mechanism. This component will handle
30    * such overwriting operations and make sure latest macro category information is presented to client code.
31    *
32    * @version $Id: b9112ac62dee7c251d587d5e236ca61086b83a57 $
33    * @since 2.0M3
34    */
35    @Role
 
36    public interface MacroCategoryManager
37    {
38    /**
39    * Returns all the macro categories currently available in the system. Macros that don't have default or overridden
40    * categories are not included and thus clients should be aware that there can be macros in the system which do
41    * not belong to any category.
42    *
43    * @return the macro categories available in the system.
44    * @throws MacroLookupException error when looking up macros
45    */
46    Set<String> getMacroCategories() throws MacroLookupException;
47   
48    /**
49    * Returns all the macro categories currently available in the system for macros registered for a given syntax
50    * and for all syntaxes. Macros that don't have default or overridden categories are not included and thus clients
51    * should be aware that there can be macros in the system which do not belong to any category.
52    *
53    * @param syntax the syntax to filter the macros by syntax.
54    * @return the macro categories available for the given syntax
55    * @throws MacroLookupException error when looking up macros
56    */
57    Set<String> getMacroCategories(Syntax syntax) throws MacroLookupException;
58   
59    /**
60    * @param category name of the category or null.
61    * @return ids of all the macros belonging to the given category or if the category parameter is null, ids of
62    * all the macros which do not belong to any category.
63    * @throws MacroLookupException error when lookup macros
64    */
65    Set<MacroId> getMacroIds(String category) throws MacroLookupException;
66   
67    /**
68    * @param category name of the category or null.
69    * @param syntax the syntax to filter the macros by syntax.
70    * @return ids of all the macros belonging to the given category (and registered for the given syntax) or if the
71    * category parameter is null, ids of all the macros which do not belong to any category (and registered
72    * for the given syntax).
73    * @throws MacroLookupException error when lookup macros
74    */
75    Set<MacroId> getMacroIds(String category, Syntax syntax) throws MacroLookupException;
76    }