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 /**
37 * CachePolicy returns instances of this class - depending on the value
38 * of the behaviour property, the cacheKey and cachedEntry values might
39 * be set or not.
40 */
41 public class CachePolicyResult {
42 public static final CachePolicyBehaviour store = new CachePolicyBehaviour("store");
43 public static final CachePolicyBehaviour useCache = new CachePolicyBehaviour("useCache");
44 public static final CachePolicyBehaviour bypass = new CachePolicyBehaviour("bypass");
45
46 private Object cachedEntry;
47 private String cacheName;
48 private final CachePolicyBehaviour behaviour;
49 private final Object cacheKey;
50
51 public CachePolicyResult(CachePolicyBehaviour behaviour, Object cacheKey, Object cachedEntry) {
52 this.behaviour = behaviour;
53 this.cacheKey = cacheKey;
54 this.cachedEntry = cachedEntry;
55 }
56
57 public CachePolicyBehaviour getBehaviour() {
58 return behaviour;
59 }
60
61 public Object getCacheKey() {
62 return cacheKey;
63 }
64
65 public void setCachedEntry(Object entry) {
66 cachedEntry = entry;
67 }
68
69 public Object getCachedEntry() {
70 return cachedEntry;
71 }
72
73 public void setCacheName(String cacheName) {
74 this.cacheName = cacheName;
75 }
76
77 public String getCacheName() {
78 return cacheName;
79 }
80
81 @Override
82 public String toString() {
83 return "CachePolicyResult{" +
84 "behaviour=" + behaviour +
85 ", cacheKey=" + cacheKey +
86 ", cachedEntry=" + cachedEntry +
87 '}';
88 }
89
90 /**
91 * Descriptor of the cache policy behavior used by this cache policy result.
92 */
93 public final static class CachePolicyBehaviour {
94 private final String name;
95
96 private CachePolicyBehaviour(String name) {
97 this.name = name;
98 }
99
100 @Override
101 public String toString() {
102 return name;
103 }
104
105 public String getName() {
106 return name;
107 }
108 }
109 }