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

File NamingCriterion.java

 

Code metrics

0
0
0
1
45
7
0
-
-
0
-

Classes

Class Line # Actions
NamingCriterion 30 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.criterion.naming;
21   
22    import org.xwiki.rendering.block.XDOM;
23   
24    /**
25    * Interface for defining various criteria for naming new documents generated while splitting.
26    *
27    * @version $Id: d5bcb1bd44a37622b1e3796596127ff4bb1e993d $
28    * @since 1.9M1
29    */
 
30    public interface NamingCriterion
31    {
32    /**
33    * Marker used to separate page indexes.
34    */
35    String INDEX_SEPERATOR = "-";
36   
37    /**
38    * Generates a suitable name for the new document represented by 'newDoc' which is a result of the splitting
39    * operation.
40    *
41    * @param newDoc the {@link XDOM} representing the newly split document.
42    * @return the name generated for the new document.
43    */
44    String getDocumentName(XDOM newDoc);
45    }