1 /**
2 * This file Copyright (c) 2008-2010 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 * @author gjoseph
42 * @version $Revision: $ ($Author: $)
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 final CachePolicyBehaviour behaviour;
50 private final Object cacheKey;
51 private Object cachedEntry;
52
53 public CachePolicyResult(CachePolicyBehaviour behaviour, Object cacheKey, Object cachedEntry) {
54 this.behaviour = behaviour;
55 this.cacheKey = cacheKey;
56 this.cachedEntry = cachedEntry;
57 }
58
59 public CachePolicyBehaviour getBehaviour() {
60 return behaviour;
61 }
62
63 public Object getCacheKey() {
64 return cacheKey;
65 }
66
67 public Object getCachedEntry() {
68 return cachedEntry;
69 }
70
71 public String toString() {
72 return "CachePolicyResult{" +
73 "behaviour=" + behaviour +
74 ", cacheKey=" + cacheKey +
75 ", cachedEntry=" + cachedEntry +
76 '}';
77 }
78
79 /**
80 * Descriptor of the cache policy behavior used by this cache policy result.
81 */
82 public final static class CachePolicyBehaviour {
83 private final String name;
84
85 private CachePolicyBehaviour(String name) {
86 this.name = name;
87 }
88
89 public String toString() {
90 return name;
91 }
92
93 public String getName() {
94 return name;
95 }
96 }
97
98 public void setCachedEntry(Object entry) {
99 cachedEntry = entry;
100 }
101
102 }