1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.internal.cache.rendering

File RenderingCache.java

 

Code metrics

0
0
0
1
68
13
0
-
-
0
-

Classes

Class Line # Actions
RenderingCache 34 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.internal.cache.rendering;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.model.reference.DocumentReference;
24   
25    import com.xpn.xwiki.XWikiContext;
26   
27    /**
28    * Cache rendering result.
29    *
30    * @version $Id: ee3eabcbb71f25700b43cd9b85d9c4ab4662b1eb $
31    * @since 2.4M1
32    */
33    @Role
 
34    public interface RenderingCache
35    {
36    /**
37    * The stored result of the rendering of the provided source.
38    *
39    * @param documentReference the reference of the document being rendered
40    * @param source the source to render
41    * @param context the XWiki context
42    * @return the cached result, null if it has not been yet cached
43    */
44    String getRenderedContent(DocumentReference documentReference, String source, XWikiContext context);
45   
46    /**
47    * Stored the result of the provided source rendering if the cache is enabled for the provided document.
48    *
49    * @param documentReference the reference of the document being rendered
50    * @param source the source to render
51    * @param renderedContent rendering result to cache
52    * @param context the XWiki context
53    */
54    void setRenderedContent(DocumentReference documentReference, String source, String renderedContent,
55    XWikiContext context);
56   
57    /**
58    * Flushes rendering cache (all cached variants) for specified document.
59    *
60    * @param documentReference the reference of the document for flushing rendering cache
61    */
62    void flushCache(DocumentReference documentReference);
63   
64    /**
65    * Flushes whole rendering cache.
66    */
67    void flushWholeCache();
68    }