1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.component.wiki

File WikiComponent.java

 

Coverage histogram

../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
1
1
1
76
16
1
1
1
1
1

Classes

Class Line # Actions
WikiComponent 35 1 0% 1 0
1.0100%
 

Contributing tests

This file is covered by 1 test. .

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.wiki;
21   
22    import java.lang.reflect.Type;
23   
24    import org.xwiki.model.reference.DocumentReference;
25    import org.xwiki.model.reference.EntityReference;
26   
27    /**
28    * Represents the definition of a wiki component implementation. A java component can extend this interface if it needs
29    * to be bound to a document, in order to be unregistered and registered again when the document is modified, and
30    * unregistered when the document is deleted.
31    *
32    * @version $Id: a60502842f2f5f1861b8997cabb8c3344a8d49d7 $
33    * @since 4.2M3
34    */
 
35    public interface WikiComponent
36    {
37    /**
38    * Get the reference of the document this component instance is bound to.
39    *
40    * @return the reference to the document holding this wiki component definition.
41    */
42    DocumentReference getDocumentReference();
43   
44    /**
45    * Get the entity reference of the bounded component instance.
46    *
47    * @return the entity reference bounded to the component
48    * @since 9.5RC1
49    */
 
50  96 toggle default EntityReference getEntityReference()
51    {
52  96 return this.getDocumentReference();
53    }
54   
55    /**
56    * Get the reference to the author of the document this component instance is bound to.
57    *
58    * @return the reference to the author of the document holding this wiki component definition.
59    */
60    DocumentReference getAuthorReference();
61   
62    /**
63    * @return the role implemented by this component implementation.
64    */
65    Type getRoleType();
66   
67    /**
68    * @return the hint of the role implemented by this component implementation.
69    */
70    String getRoleHint();
71   
72    /**
73    * @return the {@link WikiComponentScope} of the component.
74    */
75    WikiComponentScope getScope();
76    }