Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache

File CachePolicyResult.java

 

Coverage histogram

../../../../img/srcFileCovDistChart8.png
37% of files have more coverage

Code metrics

0
6
4
2
133
64
4
0.67
1.5
2
1
64.3% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
CachePolicyResult 44 4 72.7% 2 2
0.666666766.7%
CachePolicyResult.CachePolicyBehaviour 96 2 33.3% 2 0
1.0100%
 

Contributing tests

This file is covered by 25 tests. .

Source view

1    /**
2    * This file Copyright (c) 2008-2018 Magnolia International
3    * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10    * This file is distributed in the hope that it will be
11    * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12    * implied warranty of MERCHANTABILITY or FITNESS FOR A
13    * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14    * Redistribution, except as permitted by whichever of the GPL
15    * or MNA you select, is prohibited.
16    *
17    * 1. For the GPL license (GPL), you can redistribute and/or
18    * modify this file under the terms of the GNU General
19    * Public License, Version 3, as published by the Free Software
20    * Foundation. You should have received a copy of the GNU
21    * General Public License, Version 3 along with this program;
22    * if not, write to the Free Software Foundation, Inc., 51
23    * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24    *
25    * 2. For the Magnolia Network Agreement (MNA), this file
26    * and the accompanying materials are made available under the
27    * terms of the MNA which accompanies this distribution, and
28    * is available at http://www.magnolia-cms.com/mna.html
29    *
30    * Any modifications to this file must keep this entire header
31    * intact.
32    *
33    */
34    package info.magnolia.module.cache;
35   
36    import info.magnolia.module.cache.cachepolicy.result.CachePolicyResultProvider;
37    import info.magnolia.objectfactory.Components;
38   
39    /**
40    * CachePolicy returns instances of this class - depending on the value
41    * of the behaviour property, the cacheKey and cachedEntry values might
42    * be set or not.
43    */
 
44    public class CachePolicyResult {
45    public static final CachePolicyBehaviour store = new CachePolicyBehaviour("store");
46    public static final CachePolicyBehaviour useCache = new CachePolicyBehaviour("useCache");
47    public static final CachePolicyBehaviour bypass = new CachePolicyBehaviour("bypass");
48   
49    private Object cachedEntry;
50    private String cacheName;
51    private final CachePolicyBehaviour behaviour;
52    private final Object cacheKey;
53   
 
54  23 toggle public CachePolicyResult(CachePolicyBehaviour behaviour, Object cacheKey, Object cachedEntry) {
55  23 this.behaviour = behaviour;
56  23 this.cacheKey = cacheKey;
57  23 this.cachedEntry = cachedEntry;
58    }
59   
 
60    toggle public CachePolicyBehaviour getBehaviour() {
61    return behaviour;
62    }
63   
 
64    toggle public Object getCacheKey() {
65    return cacheKey;
66    }
67   
 
68    toggle public void setCachedEntry(Object entry) {
69    cachedEntry = entry;
70    }
71   
 
72    toggle public Object getCachedEntry() {
73    return cachedEntry;
74    }
75   
 
76    toggle public void setCacheName(String cacheName) {
77    this.cacheName = cacheName;
78    }
79   
 
80    toggle public String getCacheName() {
81    return cacheName;
82    }
83   
 
84  0 toggle @Override
85    public String toString() {
86  0 return "CachePolicyResult{" +
87    "behaviour=" + behaviour +
88    ", cacheKey=" + cacheKey +
89    ", cachedEntry=" + cachedEntry +
90    '}';
91    }
92   
93    /**
94    * Descriptor of the cache policy behavior used by this cache policy result.
95    */
 
96    public final static class CachePolicyBehaviour {
97    private final String name;
98   
 
99  3 toggle private CachePolicyBehaviour(String name) {
100  3 this.name = name;
101    }
102   
 
103  2 toggle @Override
104    public String toString() {
105  2 return name;
106    }
107   
 
108    toggle public String getName() {
109    return name;
110    }
111    }
112   
113    /**
114    * Saves the result in the context and makes it available by {@link #getCurrent()}.
115    *
116    * @deprecated since 5.4.7. Use {@link info.magnolia.module.cache.cachepolicy.result.CachePolicyResultProvider#setCachePolicyResult(CachePolicyResult)} instead.
117    */
 
118    toggle @Deprecated
119    public static void setCurrent(CachePolicyResult cachePolicyResult) {
120    Components.getComponent(CachePolicyResultProvider.class).setCachePolicyResult(cachePolicyResult);
121    }
122   
123    /**
124    * Returns the current {@link CachePolicyResult} which was set by the {@link info.magnolia.module.cache.filter.CacheFilter}.
125    *
126    * @deprecated since 5.4.7. Use {@link info.magnolia.module.cache.cachepolicy.result.CachePolicyResultProvider#setCachePolicyResult(CachePolicyResult)} instead.
127    */
 
128    toggle @Deprecated
129    public static CachePolicyResult getCurrent() {
130    return Components.getComponent(CachePolicyResultProvider.class).getCachePolicyResult();
131    }
132   
133    }
  • Report generated by Atlassian Clover v 4.0.4 on Mon Nov 25 2019 16:47:46 CET using coverage data from Mon Nov 25 2019 16:47:01 CET.
  • Clover: Open Source License registered to Magnolia CMS.