Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiComponentBuilder | 35 | 0 | - | 0 | 0 |
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.DocumentReference; | |
26 | ||
27 | /** | |
28 | * Allows to provide a list of documents holding one or more {@link WikiComponent}, and to build components from those | |
29 | * documents. | |
30 | * | |
31 | * @version $Id: 82eb18c9ad7516cd1570f76165acc775f5693880 $ | |
32 | * @since 4.2M3 | |
33 | */ | |
34 | @Role | |
35 | public interface WikiComponentBuilder | |
36 | { | |
37 | /** | |
38 | * Get the list of documents holding components. | |
39 | * | |
40 | * @return the list of documents holding components | |
41 | */ | |
42 | List<DocumentReference> getDocumentReferences(); | |
43 | ||
44 | /** | |
45 | * Build the components defined in a document XObjects. Being able to define more than one component in a document | |
46 | * depends on the implementation. It is up to the implementation to determine if the last author of the document | |
47 | * has the required permissions to register a component. | |
48 | * | |
49 | * @param reference the reference to the document that holds component definition objects | |
50 | * @return the constructed component definition | |
51 | * @throws WikiComponentException when the document contains invalid component definition(s) | |
52 | */ | |
53 | List<WikiComponent> buildComponents(DocumentReference reference) throws WikiComponentException; | |
54 | } |