1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.refactoring.splitter

File DocumentSplitter.java

 

Code metrics

0
0
0
1
49
12
0
-
-
0
-

Classes

Class Line # Actions
DocumentSplitter 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.refactoring.splitter;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.refactoring.WikiDocument;
26    import org.xwiki.refactoring.splitter.criterion.naming.NamingCriterion;
27    import org.xwiki.refactoring.splitter.criterion.SplittingCriterion;
28   
29    /**
30    * Component interface for splitting a {@link WikiDocument} into multiple documents.
31    *
32    * @version $Id: ffd5a90501d53ce065092a501c4123a4b980fd5b $
33    * @since 1.9M1
34    */
35    @Role
 
36    public interface DocumentSplitter
37    {
38    /**
39    * Splits the document represented by rootDoc into multiple documents.
40    *
41    * @param rootDoc the root {@link WikiDocument} which is being split.
42    * @param splittingCriterion the {@link SplittingCriterion} to be used for splitting operation.
43    * @param namingCriterion the {@link NamingCriterion} to be used to generate document names.
44    * @return a list of documents representing all the resulting documents. Note that rootDoc will be altered by this
45    * method and it will be included in the list of returned documents.
46    */
47    List<WikiDocument> split(WikiDocument rootDoc, SplittingCriterion splittingCriterion,
48    NamingCriterion namingCriterion);
49    }