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

File WikiMacroFactory.java

 

Code metrics

0
0
0
1
61
10
0
-
-
0
-

Classes

Class Line # Actions
WikiMacroFactory 32 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    import org.xwiki.model.reference.DocumentReference;
24   
25    /**
26    * Create a Wiki Macro object by gathering the Macro metadata from a document.
27    *
28    * @version $Id: 9bee96a35af06909dd7f826cf7504dac4961ee33 $
29    * @since 2.0RC1
30    */
31    @Role
 
32    public interface WikiMacroFactory
33    {
34    /**
35    * Searches the given document for a wiki macro definition.
36    *
37    * @param documentReference name of the document to search for a wiki macro definition.
38    * @return true if the given document contains a wiki macro definition, false otherwise.
39    * @since 2.2M1
40    */
41    boolean containsWikiMacro(DocumentReference documentReference);
42   
43    /**
44    * Tries to build a {@link WikiMacro} if a definition is found on the given document.
45    *
46    * @param documentReference name of the document on which the macro is defined.
47    * @return a {@link WikiMacro} corresponding to the macro definition found.
48    * @throws WikiMacroException if no macro definition is found or if an error is encountered while building
49    * the macro.
50    * @since 2.2M1
51    */
52    WikiMacro createWikiMacro(DocumentReference documentReference) throws WikiMacroException;
53   
54    /**
55    * @param documentReference the name of the document containing the wiki macro definition
56    * @param visibility the visibility required
57    * @return true if the passed visibility is allowed for the passed document.
58    * @since 4.2M1
59    */
60    boolean isAllowed(DocumentReference documentReference, WikiMacroVisibility visibility);
61    }