1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package com.xpn.xwiki.doc

File DocumentRevisionProvider.java

 

Code metrics

0
0
0
1
59
10
0
-
-
0
-

Classes

Class Line # Actions
DocumentRevisionProvider 38 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 com.xpn.xwiki.doc;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.model.reference.DocumentReference;
24   
25    import com.xpn.xwiki.XWikiException;
26   
27    /**
28    * Provide generic way of requesting a specific revision of a document from several sources (database, installed XAR
29    * extension, etc.).
30    * <p>
31    * The revision syntax is {@code <provider hint>:<revision>}, default provide being database (the version of the
32    * document in the history).
33    *
34    * @version $Id: 77d57cd41337e7cbe5d0de2985ef11404d92373e $
35    * @since 9.4RC1
36    */
37    @Role
 
38    public interface DocumentRevisionProvider
39    {
40    /**
41    * Load the document in the provided revision.
42    *
43    * @param reference the reference of the document
44    * @param revision the revision of the document
45    * @return the {@link XWikiDocument} instance or null if none existing
46    * @throws XWikiException when failing to load the document revision
47    */
48    XWikiDocument getRevision(DocumentReference reference, String revision) throws XWikiException;
49   
50    /**
51    * Load the document in the provided revision.
52    *
53    * @param document the current document
54    * @param revision the revision of the document
55    * @return the {@link XWikiDocument} instance or null if none existing
56    * @throws XWikiException when failing to load the document revision
57    */
58    XWikiDocument getRevision(XWikiDocument document, String revision) throws XWikiException;
59    }