1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.wiki.internal.descriptor.builder

File WikiDescriptorBuilder.java

 

Code metrics

0
0
0
1
54
13
0
-
-
0
-

Classes

Class Line # Actions
WikiDescriptorBuilder 37 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.wiki.internal.descriptor.builder;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.wiki.descriptor.WikiDescriptor;
26    import org.xwiki.wiki.internal.descriptor.DefaultWikiDescriptor;
27   
28    import com.xpn.xwiki.doc.XWikiDocument;
29    import com.xpn.xwiki.objects.BaseObject;
30   
31    /**
32    * Component that create WikiDescriptor object from wiki document and vice versa.
33    * @version $Id $
34    * @since 5.3M2
35    */
36    @Role
 
37    public interface WikiDescriptorBuilder
38    {
39    /**
40    * Build a wiki descriptor from a document and its objects.
41    * @param serverClassObjects objects of that page to parse
42    * @param document document that hold the wiki descriptor
43    * @return a wiki descriptor
44    */
45    DefaultWikiDescriptor buildDescriptorObject(List<BaseObject> serverClassObjects, XWikiDocument document);
46   
47    /**
48    * Save the descriptor into the wiki.
49    * @param descriptor descriptor to buildDescriptorObject
50    * @return the document that hold the descriptor
51    * @throws WikiDescriptorBuilderException if problems occur
52    */
53    XWikiDocument save(WikiDescriptor descriptor) throws WikiDescriptorBuilderException;
54    }