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

File WikiMacro.java

 

Code metrics

0
0
0
1
51
10
0
-
-
0
-

Classes

Class Line # Actions
WikiMacro 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.model.reference.DocumentReference;
23    import org.xwiki.rendering.macro.Macro;
24   
25    /**
26    * Interface for defining wiki content based xwiki rendering macros.
27    *
28    * @version $Id: 4246d0b1224362ae366247b77f9515eee753d8f8 $
29    * @since 2.0M2
30    */
 
31    public interface WikiMacro extends Macro<WikiMacroParameters>
32    {
33    /**
34    * @return the id under which this macro is registered with the component manager
35    * @deprecated since 2.3M1, use {@link org.xwiki.rendering.macro.descriptor.MacroDescriptor#getId()} instead
36    */
37    @Deprecated
38    String getId();
39   
40    /**
41    * @return the {@link DocumentReference} of the Wiki Macro
42    * @since 2.3M1
43    */
44    DocumentReference getDocumentReference();
45   
46    /**
47    * @return the author of the Wiki Macro
48    * @since 4.2M1
49    */
50    DocumentReference getAuthorReference();
51    }