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

File WikiObjectComponentBuilder.java

 

Code metrics

0
0
0
1
56
11
0
-
-
0
-

Classes

Class Line # Actions
WikiObjectComponentBuilder 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.component.wiki;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.model.reference.EntityReference;
26    import org.xwiki.model.reference.ObjectReference;
27   
28    /**
29    * Allows to build one or more {@link WikiComponent} based on the XObjects contained in an EntityReference.
30    * The role hint of the component should match the XObject class name
31    *
32    * @version $Id: 8bed8f96f484b82a5112edf3abe5dab8c9f29373 $
33    * @since 9.5RC1
34    */
35    @Role
 
36    public interface WikiObjectComponentBuilder
37    {
38    /**
39    * Get the class that should trigger {@link #buildComponents(ObjectReference)} when one XObject implementing
40    * this very class is added, updated or deleted in the wiki. The returned reference should be local if the
41    * builder is supposed to be used globally, or absolute if the builder is only used in a particular wiki.
42    *
43    * @return an {@link EntityReference} to the correct class.
44    */
45    EntityReference getClassReference();
46   
47    /**
48    * Build the components that is linked to the given {@link ObjectReference}.
49    *
50    * @param reference the reference of the object that should be used to create the component.
51    * @return the new component
52    * @throws WikiComponentException if the given {@link ObjectReference} is incompatible with the current builder or
53    * if the {@link WikiComponentBuilder} has not been able to instanciate the component.
54    */
55    List<WikiComponent> buildComponents(ObjectReference reference) throws WikiComponentException;
56    }