You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@turbine.apache.org by gk...@apache.org on 2021/08/04 05:57:40 UTC
svn commit: r1076287 [12/35] - in
/websites/production/turbine/content/fulcrum/fulcrum-cache: ./
announcements/ apidocs/ apidocs/org/apache/fulcrum/cache/
apidocs/org/apache/fulcrum/cache/class-use/
apidocs/org/apache/fulcrum/cache/impl/ apidocs/org/ap...
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/CachedObject.html
==============================================================================
--- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/CachedObject.html (original)
+++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/CachedObject.html Wed Aug 4 05:57:38 2021
@@ -1,259 +1,259 @@
-<HTML>
-<BODY BGCOLOR="white">
-<PRE>
-<FONT color="green">001</FONT> package org.apache.fulcrum.cache;<a name="line.1"></a>
-<FONT color="green">002</FONT> <a name="line.2"></a>
-<FONT color="green">003</FONT> /*<a name="line.3"></a>
-<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
-<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
-<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
-<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
-<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
-<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
-<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
-<FONT color="green">011</FONT> *<a name="line.11"></a>
-<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
-<FONT color="green">013</FONT> *<a name="line.13"></a>
-<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
-<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
-<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
-<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
-<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
-<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
-<FONT color="green">020</FONT> */<a name="line.20"></a>
-<FONT color="green">021</FONT> <a name="line.21"></a>
-<FONT color="green">022</FONT> import java.io.Serializable;<a name="line.22"></a>
-<FONT color="green">023</FONT> <a name="line.23"></a>
-<FONT color="green">024</FONT> /**<a name="line.24"></a>
-<FONT color="green">025</FONT> * Wrapper for an object you want to store in a cache for a period of time.<a name="line.25"></a>
-<FONT color="green">026</FONT> * <a name="line.26"></a>
-<FONT color="green">027</FONT> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a><a name="line.27"></a>
-<FONT color="green">028</FONT> * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a><a name="line.28"></a>
-<FONT color="green">029</FONT> * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a><a name="line.29"></a>
-<FONT color="green">030</FONT> * @version $Id: CachedObject.java 670326 2008-06-22 09:31:47Z tv $<a name="line.30"></a>
-<FONT color="green">031</FONT> */<a name="line.31"></a>
-<FONT color="green">032</FONT> <a name="line.32"></a>
-<FONT color="green">033</FONT> public class CachedObject implements Serializable<a name="line.33"></a>
-<FONT color="green">034</FONT> {<a name="line.34"></a>
-<FONT color="green">035</FONT> /*<a name="line.35"></a>
-<FONT color="green">036</FONT> * TODO: The old Turbine version you could set the default age from Turbine.<a name="line.36"></a>
-<FONT color="green">037</FONT> * What we need is a CachedObjectFactory that would generate CachedObject's<a name="line.37"></a>
-<FONT color="green">038</FONT> * that could then have their default age set.<a name="line.38"></a>
-<FONT color="green">039</FONT> */<a name="line.39"></a>
-<FONT color="green">040</FONT> <a name="line.40"></a>
-<FONT color="green">041</FONT> /**<a name="line.41"></a>
-<FONT color="green">042</FONT> * Serialization key<a name="line.42"></a>
-<FONT color="green">043</FONT> */<a name="line.43"></a>
-<FONT color="green">044</FONT> private static final long serialVersionUID = -9107764093769042092L;<a name="line.44"></a>
-<FONT color="green">045</FONT> <a name="line.45"></a>
-<FONT color="green">046</FONT> /** Cache the object with the Default TTL */<a name="line.46"></a>
-<FONT color="green">047</FONT> public static final int DEFAULT = 0;<a name="line.47"></a>
-<FONT color="green">048</FONT> <a name="line.48"></a>
-<FONT color="green">049</FONT> /** Do not expire the object */<a name="line.49"></a>
-<FONT color="green">050</FONT> public static final int FOREVER = -1;<a name="line.50"></a>
-<FONT color="green">051</FONT> <a name="line.51"></a>
-<FONT color="green">052</FONT> /** The object to be cached. */<a name="line.52"></a>
-<FONT color="green">053</FONT> private Object contents = null;<a name="line.53"></a>
-<FONT color="green">054</FONT> <a name="line.54"></a>
-<FONT color="green">055</FONT> /** Default age (30 minutes). */<a name="line.55"></a>
-<FONT color="green">056</FONT> private long defaultage = 1800000;<a name="line.56"></a>
-<FONT color="green">057</FONT> <a name="line.57"></a>
-<FONT color="green">058</FONT> /** When created. * */<a name="line.58"></a>
-<FONT color="green">059</FONT> protected long created = 0;<a name="line.59"></a>
-<FONT color="green">060</FONT> <a name="line.60"></a>
-<FONT color="green">061</FONT> /** When it expires. * */<a name="line.61"></a>
-<FONT color="green">062</FONT> private long expires = 0;<a name="line.62"></a>
-<FONT color="green">063</FONT> <a name="line.63"></a>
-<FONT color="green">064</FONT> /** Is this object stale/expired? */<a name="line.64"></a>
-<FONT color="green">065</FONT> private boolean stale = false;<a name="line.65"></a>
-<FONT color="green">066</FONT> <a name="line.66"></a>
-<FONT color="green">067</FONT> /**<a name="line.67"></a>
-<FONT color="green">068</FONT> * Constructor; sets the object to expire in the default time (30 minutes).<a name="line.68"></a>
-<FONT color="green">069</FONT> * <a name="line.69"></a>
-<FONT color="green">070</FONT> * @param o<a name="line.70"></a>
-<FONT color="green">071</FONT> * The object you want to cache.<a name="line.71"></a>
-<FONT color="green">072</FONT> */<a name="line.72"></a>
-<FONT color="green">073</FONT> public CachedObject(Object o)<a name="line.73"></a>
-<FONT color="green">074</FONT> {<a name="line.74"></a>
-<FONT color="green">075</FONT> this.contents = o;<a name="line.75"></a>
-<FONT color="green">076</FONT> this.expires = this.defaultage;<a name="line.76"></a>
-<FONT color="green">077</FONT> this.created = System.currentTimeMillis();<a name="line.77"></a>
-<FONT color="green">078</FONT> }<a name="line.78"></a>
-<FONT color="green">079</FONT> <a name="line.79"></a>
-<FONT color="green">080</FONT> /**<a name="line.80"></a>
-<FONT color="green">081</FONT> * Constructor.<a name="line.81"></a>
-<FONT color="green">082</FONT> * <a name="line.82"></a>
-<FONT color="green">083</FONT> * @param o<a name="line.83"></a>
-<FONT color="green">084</FONT> * The object to cache.<a name="line.84"></a>
-<FONT color="green">085</FONT> * @param expires<a name="line.85"></a>
-<FONT color="green">086</FONT> * How long before the object expires, in ms, e.g. 1000 = 1<a name="line.86"></a>
-<FONT color="green">087</FONT> * second.<a name="line.87"></a>
-<FONT color="green">088</FONT> */<a name="line.88"></a>
-<FONT color="green">089</FONT> public CachedObject(Object o, long expires)<a name="line.89"></a>
-<FONT color="green">090</FONT> {<a name="line.90"></a>
-<FONT color="green">091</FONT> if (expires == DEFAULT)<a name="line.91"></a>
-<FONT color="green">092</FONT> {<a name="line.92"></a>
-<FONT color="green">093</FONT> this.expires = this.defaultage;<a name="line.93"></a>
-<FONT color="green">094</FONT> }<a name="line.94"></a>
-<FONT color="green">095</FONT> <a name="line.95"></a>
-<FONT color="green">096</FONT> this.contents = o;<a name="line.96"></a>
-<FONT color="green">097</FONT> this.expires = expires;<a name="line.97"></a>
-<FONT color="green">098</FONT> this.created = System.currentTimeMillis();<a name="line.98"></a>
-<FONT color="green">099</FONT> }<a name="line.99"></a>
-<FONT color="green">100</FONT> <a name="line.100"></a>
-<FONT color="green">101</FONT> /**<a name="line.101"></a>
-<FONT color="green">102</FONT> * Returns the cached object.<a name="line.102"></a>
-<FONT color="green">103</FONT> * <a name="line.103"></a>
-<FONT color="green">104</FONT> * @return The cached object.<a name="line.104"></a>
-<FONT color="green">105</FONT> */<a name="line.105"></a>
-<FONT color="green">106</FONT> public Object getContents()<a name="line.106"></a>
-<FONT color="green">107</FONT> {<a name="line.107"></a>
-<FONT color="green">108</FONT> return this.contents;<a name="line.108"></a>
-<FONT color="green">109</FONT> }<a name="line.109"></a>
-<FONT color="green">110</FONT> <a name="line.110"></a>
-<FONT color="green">111</FONT> /**<a name="line.111"></a>
-<FONT color="green">112</FONT> * Returns the creation time for the object.<a name="line.112"></a>
-<FONT color="green">113</FONT> * <a name="line.113"></a>
-<FONT color="green">114</FONT> * @return When the object was created.<a name="line.114"></a>
-<FONT color="green">115</FONT> */<a name="line.115"></a>
-<FONT color="green">116</FONT> public long getCreated()<a name="line.116"></a>
-<FONT color="green">117</FONT> {<a name="line.117"></a>
-<FONT color="green">118</FONT> return this.created;<a name="line.118"></a>
-<FONT color="green">119</FONT> }<a name="line.119"></a>
-<FONT color="green">120</FONT> <a name="line.120"></a>
-<FONT color="green">121</FONT> /**<a name="line.121"></a>
-<FONT color="green">122</FONT> * Returns the expiration time for the object.<a name="line.122"></a>
-<FONT color="green">123</FONT> * <a name="line.123"></a>
-<FONT color="green">124</FONT> * @return When the object expires.<a name="line.124"></a>
-<FONT color="green">125</FONT> */<a name="line.125"></a>
-<FONT color="green">126</FONT> public long getExpires()<a name="line.126"></a>
-<FONT color="green">127</FONT> {<a name="line.127"></a>
-<FONT color="green">128</FONT> return this.expires;<a name="line.128"></a>
-<FONT color="green">129</FONT> }<a name="line.129"></a>
-<FONT color="green">130</FONT> <a name="line.130"></a>
-<FONT color="green">131</FONT> /**<a name="line.131"></a>
-<FONT color="green">132</FONT> * Set the expiration interval for the object.<a name="line.132"></a>
-<FONT color="green">133</FONT> * <a name="line.133"></a>
-<FONT color="green">134</FONT> * @param expires<a name="line.134"></a>
-<FONT color="green">135</FONT> * Expiration interval in millis ( 1 second = 1000 millis)<a name="line.135"></a>
-<FONT color="green">136</FONT> */<a name="line.136"></a>
-<FONT color="green">137</FONT> public void setExpires(long expires)<a name="line.137"></a>
-<FONT color="green">138</FONT> {<a name="line.138"></a>
-<FONT color="green">139</FONT> if (expires == DEFAULT)<a name="line.139"></a>
-<FONT color="green">140</FONT> {<a name="line.140"></a>
-<FONT color="green">141</FONT> this.expires = this.defaultage;<a name="line.141"></a>
-<FONT color="green">142</FONT> }<a name="line.142"></a>
-<FONT color="green">143</FONT> else<a name="line.143"></a>
-<FONT color="green">144</FONT> {<a name="line.144"></a>
-<FONT color="green">145</FONT> this.expires = expires;<a name="line.145"></a>
-<FONT color="green">146</FONT> }<a name="line.146"></a>
-<FONT color="green">147</FONT> if (expires == FOREVER)<a name="line.147"></a>
-<FONT color="green">148</FONT> {<a name="line.148"></a>
-<FONT color="green">149</FONT> setStale(false);<a name="line.149"></a>
-<FONT color="green">150</FONT> }<a name="line.150"></a>
-<FONT color="green">151</FONT> else<a name="line.151"></a>
-<FONT color="green">152</FONT> {<a name="line.152"></a>
-<FONT color="green">153</FONT> setStale((System.currentTimeMillis() - this.created) > expires);<a name="line.153"></a>
-<FONT color="green">154</FONT> }<a name="line.154"></a>
-<FONT color="green">155</FONT> }<a name="line.155"></a>
-<FONT color="green">156</FONT> <a name="line.156"></a>
-<FONT color="green">157</FONT> /**<a name="line.157"></a>
-<FONT color="green">158</FONT> * Set the stale status for the object.<a name="line.158"></a>
-<FONT color="green">159</FONT> * <a name="line.159"></a>
-<FONT color="green">160</FONT> * @param stale<a name="line.160"></a>
-<FONT color="green">161</FONT> * Whether the object is stale or not.<a name="line.161"></a>
-<FONT color="green">162</FONT> */<a name="line.162"></a>
-<FONT color="green">163</FONT> public synchronized void setStale(boolean stale)<a name="line.163"></a>
-<FONT color="green">164</FONT> {<a name="line.164"></a>
-<FONT color="green">165</FONT> this.stale = stale;<a name="line.165"></a>
-<FONT color="green">166</FONT> }<a name="line.166"></a>
-<FONT color="green">167</FONT> <a name="line.167"></a>
-<FONT color="green">168</FONT> /**<a name="line.168"></a>
-<FONT color="green">169</FONT> * Get the stale status for the object.<a name="line.169"></a>
-<FONT color="green">170</FONT> * <a name="line.170"></a>
-<FONT color="green">171</FONT> * @return Whether the object is stale or not.<a name="line.171"></a>
-<FONT color="green">172</FONT> */<a name="line.172"></a>
-<FONT color="green">173</FONT> public synchronized boolean getStale()<a name="line.173"></a>
-<FONT color="green">174</FONT> {<a name="line.174"></a>
-<FONT color="green">175</FONT> return this.stale;<a name="line.175"></a>
-<FONT color="green">176</FONT> }<a name="line.176"></a>
-<FONT color="green">177</FONT> <a name="line.177"></a>
-<FONT color="green">178</FONT> /**<a name="line.178"></a>
-<FONT color="green">179</FONT> * Is the object stale?<a name="line.179"></a>
-<FONT color="green">180</FONT> * <a name="line.180"></a>
-<FONT color="green">181</FONT> * @return True if the object is stale.<a name="line.181"></a>
-<FONT color="green">182</FONT> */<a name="line.182"></a>
-<FONT color="green">183</FONT> public synchronized boolean isStale()<a name="line.183"></a>
-<FONT color="green">184</FONT> {<a name="line.184"></a>
-<FONT color="green">185</FONT> if (this.expires == FOREVER)<a name="line.185"></a>
-<FONT color="green">186</FONT> {<a name="line.186"></a>
-<FONT color="green">187</FONT> return false;<a name="line.187"></a>
-<FONT color="green">188</FONT> }<a name="line.188"></a>
-<FONT color="green">189</FONT> <a name="line.189"></a>
-<FONT color="green">190</FONT> setStale((System.currentTimeMillis() - this.created) > this.expires);<a name="line.190"></a>
-<FONT color="green">191</FONT> return getStale();<a name="line.191"></a>
-<FONT color="green">192</FONT> }<a name="line.192"></a>
-<FONT color="green">193</FONT> }<a name="line.193"></a>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</PRE>
-</BODY>
-</HTML>
+<!DOCTYPE HTML>
+<html lang="de">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.cache;</a>
+<span class="sourceLineNo">002</span><a id="line.2"></a>
+<span class="sourceLineNo">003</span><a id="line.3">/*</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
+<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
+<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">011</span><a id="line.11"> *</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">013</span><a id="line.13"> *</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
+<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
+<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
+<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
+<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
+<span class="sourceLineNo">020</span><a id="line.20"> */</a>
+<span class="sourceLineNo">021</span><a id="line.21"></a>
+<span class="sourceLineNo">022</span><a id="line.22">import java.io.Serializable;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import java.util.concurrent.atomic.AtomicBoolean;</a>
+<span class="sourceLineNo">024</span><a id="line.24"></a>
+<span class="sourceLineNo">025</span><a id="line.25">/**</a>
+<span class="sourceLineNo">026</span><a id="line.26"> * Wrapper for an object you want to store in a cache for a period of time.</a>
+<span class="sourceLineNo">027</span><a id="line.27"> *</a>
+<span class="sourceLineNo">028</span><a id="line.28"> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a></a>
+<span class="sourceLineNo">029</span><a id="line.29"> * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a></a>
+<span class="sourceLineNo">030</span><a id="line.30"> * @author <a href="mailto:epugh@upstate.com">Eric Pugh</a></a>
+<span class="sourceLineNo">031</span><a id="line.31"> * @version $Id: CachedObject.java 1890338 2021-05-31 10:31:19Z gk $</a>
+<span class="sourceLineNo">032</span><a id="line.32"> */</a>
+<span class="sourceLineNo">033</span><a id="line.33"></a>
+<span class="sourceLineNo">034</span><a id="line.34">public class CachedObject<T> implements Serializable</a>
+<span class="sourceLineNo">035</span><a id="line.35">{</a>
+<span class="sourceLineNo">036</span><a id="line.36"> /*</a>
+<span class="sourceLineNo">037</span><a id="line.37"> * TODO: The old Turbine version you could set the default age from Turbine.</a>
+<span class="sourceLineNo">038</span><a id="line.38"> * What we need is a CachedObjectFactory that would generate CachedObject's</a>
+<span class="sourceLineNo">039</span><a id="line.39"> * that could then have their default age set.</a>
+<span class="sourceLineNo">040</span><a id="line.40"> */</a>
+<span class="sourceLineNo">041</span><a id="line.41"></a>
+<span class="sourceLineNo">042</span><a id="line.42"> /**</a>
+<span class="sourceLineNo">043</span><a id="line.43"> * Serialization key</a>
+<span class="sourceLineNo">044</span><a id="line.44"> */</a>
+<span class="sourceLineNo">045</span><a id="line.45"> private static final long serialVersionUID = -9107764093769042092L;</a>
+<span class="sourceLineNo">046</span><a id="line.46"></a>
+<span class="sourceLineNo">047</span><a id="line.47"> /** Cache the object with the Default TTL */</a>
+<span class="sourceLineNo">048</span><a id="line.48"> public static final int DEFAULT = 0;</a>
+<span class="sourceLineNo">049</span><a id="line.49"></a>
+<span class="sourceLineNo">050</span><a id="line.50"> /** Do not expire the object */</a>
+<span class="sourceLineNo">051</span><a id="line.51"> public static final int FOREVER = -1;</a>
+<span class="sourceLineNo">052</span><a id="line.52"></a>
+<span class="sourceLineNo">053</span><a id="line.53"> /** The object to be cached. */</a>
+<span class="sourceLineNo">054</span><a id="line.54"> private T contents = null;</a>
+<span class="sourceLineNo">055</span><a id="line.55"></a>
+<span class="sourceLineNo">056</span><a id="line.56"> /** Default age (30 minutes). */</a>
+<span class="sourceLineNo">057</span><a id="line.57"> private static final long DEFAULT_AGE = 1_800_000;</a>
+<span class="sourceLineNo">058</span><a id="line.58"></a>
+<span class="sourceLineNo">059</span><a id="line.59"> /** When the object is created. */</a>
+<span class="sourceLineNo">060</span><a id="line.60"> protected long created;</a>
+<span class="sourceLineNo">061</span><a id="line.61"></a>
+<span class="sourceLineNo">062</span><a id="line.62"> /** When the object should expire. */</a>
+<span class="sourceLineNo">063</span><a id="line.63"> private long expires;</a>
+<span class="sourceLineNo">064</span><a id="line.64"></a>
+<span class="sourceLineNo">065</span><a id="line.65"> /** Is this object stale/expired? */</a>
+<span class="sourceLineNo">066</span><a id="line.66"> private final AtomicBoolean stale = new AtomicBoolean();</a>
+<span class="sourceLineNo">067</span><a id="line.67"></a>
+<span class="sourceLineNo">068</span><a id="line.68"> /**</a>
+<span class="sourceLineNo">069</span><a id="line.69"> * Constructor; sets the object to expire in the default time (30 minutes).</a>
+<span class="sourceLineNo">070</span><a id="line.70"> *</a>
+<span class="sourceLineNo">071</span><a id="line.71"> * @param object</a>
+<span class="sourceLineNo">072</span><a id="line.72"> * The object you want to cache.</a>
+<span class="sourceLineNo">073</span><a id="line.73"> */</a>
+<span class="sourceLineNo">074</span><a id="line.74"> public CachedObject(final T object)</a>
+<span class="sourceLineNo">075</span><a id="line.75"> {</a>
+<span class="sourceLineNo">076</span><a id="line.76"> this(object, DEFAULT);</a>
+<span class="sourceLineNo">077</span><a id="line.77"> }</a>
+<span class="sourceLineNo">078</span><a id="line.78"></a>
+<span class="sourceLineNo">079</span><a id="line.79"> /**</a>
+<span class="sourceLineNo">080</span><a id="line.80"> * Constructor.</a>
+<span class="sourceLineNo">081</span><a id="line.81"> *</a>
+<span class="sourceLineNo">082</span><a id="line.82"> * @param object</a>
+<span class="sourceLineNo">083</span><a id="line.83"> * The object to cache.</a>
+<span class="sourceLineNo">084</span><a id="line.84"> * @param expires</a>
+<span class="sourceLineNo">085</span><a id="line.85"> * How long before the object expires, in ms, e.g. 1000 = 1</a>
+<span class="sourceLineNo">086</span><a id="line.86"> * second.</a>
+<span class="sourceLineNo">087</span><a id="line.87"> */</a>
+<span class="sourceLineNo">088</span><a id="line.88"> public CachedObject(final T object, final long expires)</a>
+<span class="sourceLineNo">089</span><a id="line.89"> {</a>
+<span class="sourceLineNo">090</span><a id="line.90"> if (expires == DEFAULT)</a>
+<span class="sourceLineNo">091</span><a id="line.91"> {</a>
+<span class="sourceLineNo">092</span><a id="line.92"> this.expires = this.DEFAULT_AGE;</a>
+<span class="sourceLineNo">093</span><a id="line.93"> } else {</a>
+<span class="sourceLineNo">094</span><a id="line.94"> this.expires = expires;</a>
+<span class="sourceLineNo">095</span><a id="line.95"> }</a>
+<span class="sourceLineNo">096</span><a id="line.96"></a>
+<span class="sourceLineNo">097</span><a id="line.97"> this.contents = object;</a>
+<span class="sourceLineNo">098</span><a id="line.98"></a>
+<span class="sourceLineNo">099</span><a id="line.99"> this.created = System.currentTimeMillis();</a>
+<span class="sourceLineNo">100</span><a id="line.100"> }</a>
+<span class="sourceLineNo">101</span><a id="line.101"></a>
+<span class="sourceLineNo">102</span><a id="line.102"> /**</a>
+<span class="sourceLineNo">103</span><a id="line.103"> * Returns the cached object.</a>
+<span class="sourceLineNo">104</span><a id="line.104"> *</a>
+<span class="sourceLineNo">105</span><a id="line.105"> * @return The cached object.</a>
+<span class="sourceLineNo">106</span><a id="line.106"> */</a>
+<span class="sourceLineNo">107</span><a id="line.107"> public T getContents()</a>
+<span class="sourceLineNo">108</span><a id="line.108"> {</a>
+<span class="sourceLineNo">109</span><a id="line.109"> return this.contents;</a>
+<span class="sourceLineNo">110</span><a id="line.110"> }</a>
+<span class="sourceLineNo">111</span><a id="line.111"></a>
+<span class="sourceLineNo">112</span><a id="line.112"> /**</a>
+<span class="sourceLineNo">113</span><a id="line.113"> * Returns the creation time for the object.</a>
+<span class="sourceLineNo">114</span><a id="line.114"> *</a>
+<span class="sourceLineNo">115</span><a id="line.115"> * @return When the object was created.</a>
+<span class="sourceLineNo">116</span><a id="line.116"> */</a>
+<span class="sourceLineNo">117</span><a id="line.117"> public long getCreated()</a>
+<span class="sourceLineNo">118</span><a id="line.118"> {</a>
+<span class="sourceLineNo">119</span><a id="line.119"> return this.created;</a>
+<span class="sourceLineNo">120</span><a id="line.120"> }</a>
+<span class="sourceLineNo">121</span><a id="line.121"></a>
+<span class="sourceLineNo">122</span><a id="line.122"> /**</a>
+<span class="sourceLineNo">123</span><a id="line.123"> * Returns the expiration time for the object.</a>
+<span class="sourceLineNo">124</span><a id="line.124"> *</a>
+<span class="sourceLineNo">125</span><a id="line.125"> * @return When the object expires.</a>
+<span class="sourceLineNo">126</span><a id="line.126"> */</a>
+<span class="sourceLineNo">127</span><a id="line.127"> public long getExpires()</a>
+<span class="sourceLineNo">128</span><a id="line.128"> {</a>
+<span class="sourceLineNo">129</span><a id="line.129"> return this.expires;</a>
+<span class="sourceLineNo">130</span><a id="line.130"> }</a>
+<span class="sourceLineNo">131</span><a id="line.131"></a>
+<span class="sourceLineNo">132</span><a id="line.132"> /**</a>
+<span class="sourceLineNo">133</span><a id="line.133"> * Set the expiration interval for the object.</a>
+<span class="sourceLineNo">134</span><a id="line.134"> *</a>
+<span class="sourceLineNo">135</span><a id="line.135"> * @param expires</a>
+<span class="sourceLineNo">136</span><a id="line.136"> * Expiration interval in millis ( 1 second = 1000 millis)</a>
+<span class="sourceLineNo">137</span><a id="line.137"> */</a>
+<span class="sourceLineNo">138</span><a id="line.138"> public void setExpires(final long expires)</a>
+<span class="sourceLineNo">139</span><a id="line.139"> {</a>
+<span class="sourceLineNo">140</span><a id="line.140"> if (expires == DEFAULT)</a>
+<span class="sourceLineNo">141</span><a id="line.141"> {</a>
+<span class="sourceLineNo">142</span><a id="line.142"> this.expires = this.DEFAULT_AGE;</a>
+<span class="sourceLineNo">143</span><a id="line.143"> }</a>
+<span class="sourceLineNo">144</span><a id="line.144"> else</a>
+<span class="sourceLineNo">145</span><a id="line.145"> {</a>
+<span class="sourceLineNo">146</span><a id="line.146"> this.expires = expires;</a>
+<span class="sourceLineNo">147</span><a id="line.147"> }</a>
+<span class="sourceLineNo">148</span><a id="line.148"> if (expires == FOREVER)</a>
+<span class="sourceLineNo">149</span><a id="line.149"> {</a>
+<span class="sourceLineNo">150</span><a id="line.150"> setStale(false);</a>
+<span class="sourceLineNo">151</span><a id="line.151"> }</a>
+<span class="sourceLineNo">152</span><a id="line.152"> else</a>
+<span class="sourceLineNo">153</span><a id="line.153"> {</a>
+<span class="sourceLineNo">154</span><a id="line.154"> setStale((System.currentTimeMillis() - this.created) > expires);</a>
+<span class="sourceLineNo">155</span><a id="line.155"> }</a>
+<span class="sourceLineNo">156</span><a id="line.156"> }</a>
+<span class="sourceLineNo">157</span><a id="line.157"></a>
+<span class="sourceLineNo">158</span><a id="line.158"> /**</a>
+<span class="sourceLineNo">159</span><a id="line.159"> * Set the stale status for the object.</a>
+<span class="sourceLineNo">160</span><a id="line.160"> *</a>
+<span class="sourceLineNo">161</span><a id="line.161"> * @param stale</a>
+<span class="sourceLineNo">162</span><a id="line.162"> * Whether the object is stale or not.</a>
+<span class="sourceLineNo">163</span><a id="line.163"> */</a>
+<span class="sourceLineNo">164</span><a id="line.164"> public void setStale(final boolean stale)</a>
+<span class="sourceLineNo">165</span><a id="line.165"> {</a>
+<span class="sourceLineNo">166</span><a id="line.166"> this.stale.set( stale );</a>
+<span class="sourceLineNo">167</span><a id="line.167"> }</a>
+<span class="sourceLineNo">168</span><a id="line.168"> </a>
+<span class="sourceLineNo">169</span><a id="line.169"></a>
+<span class="sourceLineNo">170</span><a id="line.170"> /**</a>
+<span class="sourceLineNo">171</span><a id="line.171"> * Is the object stale?</a>
+<span class="sourceLineNo">172</span><a id="line.172"> *</a>
+<span class="sourceLineNo">173</span><a id="line.173"> * @return True if the object is stale.</a>
+<span class="sourceLineNo">174</span><a id="line.174"> */</a>
+<span class="sourceLineNo">175</span><a id="line.175"> public boolean isStale()</a>
+<span class="sourceLineNo">176</span><a id="line.176"> {</a>
+<span class="sourceLineNo">177</span><a id="line.177"> boolean currentState = false;</a>
+<span class="sourceLineNo">178</span><a id="line.178"> if (this.expires != FOREVER)</a>
+<span class="sourceLineNo">179</span><a id="line.179"> {</a>
+<span class="sourceLineNo">180</span><a id="line.180"> setStale((System.currentTimeMillis() - this.created) > this.expires);</a>
+<span class="sourceLineNo">181</span><a id="line.181"> currentState = this.stale.get();</a>
+<span class="sourceLineNo">182</span><a id="line.182"> }</a>
+<span class="sourceLineNo">183</span><a id="line.183"> return currentState;</a>
+<span class="sourceLineNo">184</span><a id="line.184"> }</a>
+<span class="sourceLineNo">185</span><a id="line.185">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
\ No newline at end of file
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/GlobalCacheService.html
==============================================================================
--- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/GlobalCacheService.html (original)
+++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/GlobalCacheService.html Wed Aug 4 05:57:38 2021
@@ -1,169 +1,178 @@
-<HTML>
-<BODY BGCOLOR="white">
-<PRE>
-<FONT color="green">001</FONT> package org.apache.fulcrum.cache;<a name="line.1"></a>
-<FONT color="green">002</FONT> <a name="line.2"></a>
-<FONT color="green">003</FONT> /*<a name="line.3"></a>
-<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
-<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
-<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
-<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
-<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
-<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
-<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
-<FONT color="green">011</FONT> *<a name="line.11"></a>
-<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
-<FONT color="green">013</FONT> *<a name="line.13"></a>
-<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
-<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
-<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
-<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
-<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
-<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
-<FONT color="green">020</FONT> */<a name="line.20"></a>
-<FONT color="green">021</FONT> <a name="line.21"></a>
-<FONT color="green">022</FONT> import java.io.IOException;<a name="line.22"></a>
-<FONT color="green">023</FONT> import java.util.List;<a name="line.23"></a>
-<FONT color="green">024</FONT> <a name="line.24"></a>
-<FONT color="green">025</FONT> import org.apache.avalon.framework.component.Component;<a name="line.25"></a>
-<FONT color="green">026</FONT> <a name="line.26"></a>
-<FONT color="green">027</FONT> /**<a name="line.27"></a>
-<FONT color="green">028</FONT> * GlobalCacheService interface.<a name="line.28"></a>
-<FONT color="green">029</FONT> * <a name="line.29"></a>
-<FONT color="green">030</FONT> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a><a name="line.30"></a>
-<FONT color="green">031</FONT> * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a><a name="line.31"></a>
-<FONT color="green">032</FONT> * @version $Id: GlobalCacheService.java 927153 2010-03-24 18:55:08Z tv $<a name="line.32"></a>
-<FONT color="green">033</FONT> */<a name="line.33"></a>
-<FONT color="green">034</FONT> public interface GlobalCacheService extends Component<a name="line.34"></a>
-<FONT color="green">035</FONT> {<a name="line.35"></a>
-<FONT color="green">036</FONT> /** Avalon role - used to id the component within the manager */<a name="line.36"></a>
-<FONT color="green">037</FONT> String ROLE = GlobalCacheService.class.getName();<a name="line.37"></a>
-<FONT color="green">038</FONT> <a name="line.38"></a>
-<FONT color="green">039</FONT> /**<a name="line.39"></a>
-<FONT color="green">040</FONT> * Gets a cached object given its id (a String).<a name="line.40"></a>
-<FONT color="green">041</FONT> * <a name="line.41"></a>
-<FONT color="green">042</FONT> * @param id<a name="line.42"></a>
-<FONT color="green">043</FONT> * The String id for the object.<a name="line.43"></a>
-<FONT color="green">044</FONT> * @return A CachedObject.<a name="line.44"></a>
-<FONT color="green">045</FONT> * @exception ObjectExpiredException,<a name="line.45"></a>
-<FONT color="green">046</FONT> * if the object has expired in the cache.<a name="line.46"></a>
-<FONT color="green">047</FONT> */<a name="line.47"></a>
-<FONT color="green">048</FONT> CachedObject getObject(String id) throws ObjectExpiredException;<a name="line.48"></a>
-<FONT color="green">049</FONT> <a name="line.49"></a>
-<FONT color="green">050</FONT> /**<a name="line.50"></a>
-<FONT color="green">051</FONT> * Adds an object to the cache.<a name="line.51"></a>
-<FONT color="green">052</FONT> * <a name="line.52"></a>
-<FONT color="green">053</FONT> * @param id<a name="line.53"></a>
-<FONT color="green">054</FONT> * The String id for the object.<a name="line.54"></a>
-<FONT color="green">055</FONT> * @param o<a name="line.55"></a>
-<FONT color="green">056</FONT> * The object to add to the cache.<a name="line.56"></a>
-<FONT color="green">057</FONT> */<a name="line.57"></a>
-<FONT color="green">058</FONT> void addObject(String id, CachedObject o);<a name="line.58"></a>
-<FONT color="green">059</FONT> <a name="line.59"></a>
-<FONT color="green">060</FONT> /**<a name="line.60"></a>
-<FONT color="green">061</FONT> * Removes an object from the cache.<a name="line.61"></a>
-<FONT color="green">062</FONT> * <a name="line.62"></a>
-<FONT color="green">063</FONT> * @param id<a name="line.63"></a>
-<FONT color="green">064</FONT> * The String id for the object.<a name="line.64"></a>
-<FONT color="green">065</FONT> */<a name="line.65"></a>
-<FONT color="green">066</FONT> void removeObject(String id);<a name="line.66"></a>
-<FONT color="green">067</FONT> <a name="line.67"></a>
-<FONT color="green">068</FONT> /**<a name="line.68"></a>
-<FONT color="green">069</FONT> * Returns a copy of keys to objects in the cache as a list.<a name="line.69"></a>
-<FONT color="green">070</FONT> * <a name="line.70"></a>
-<FONT color="green">071</FONT> * Note that keys to expired objects are not returned.<a name="line.71"></a>
-<FONT color="green">072</FONT> * <a name="line.72"></a>
-<FONT color="green">073</FONT> * @return A List of <code>String</code>'s representing the keys to<a name="line.73"></a>
-<FONT color="green">074</FONT> * objects in the cache.<a name="line.74"></a>
-<FONT color="green">075</FONT> */<a name="line.75"></a>
-<FONT color="green">076</FONT> public List getKeys();<a name="line.76"></a>
-<FONT color="green">077</FONT> <a name="line.77"></a>
-<FONT color="green">078</FONT> /**<a name="line.78"></a>
-<FONT color="green">079</FONT> * Returns a copy of the non-expired CachedObjects in the cache as a list.<a name="line.79"></a>
-<FONT color="green">080</FONT> * <a name="line.80"></a>
-<FONT color="green">081</FONT> * @return A List of <code>CachedObject</code> objects held in the cache<a name="line.81"></a>
-<FONT color="green">082</FONT> */<a name="line.82"></a>
-<FONT color="green">083</FONT> public List getCachedObjects();<a name="line.83"></a>
-<FONT color="green">084</FONT> <a name="line.84"></a>
-<FONT color="green">085</FONT> /**<a name="line.85"></a>
-<FONT color="green">086</FONT> * Returns the current size of the cache.<a name="line.86"></a>
-<FONT color="green">087</FONT> * <a name="line.87"></a>
-<FONT color="green">088</FONT> * @return int representing current cache size in number of bytes<a name="line.88"></a>
-<FONT color="green">089</FONT> */<a name="line.89"></a>
-<FONT color="green">090</FONT> int getCacheSize() throws IOException;<a name="line.90"></a>
-<FONT color="green">091</FONT> <a name="line.91"></a>
-<FONT color="green">092</FONT> /**<a name="line.92"></a>
-<FONT color="green">093</FONT> * Returns the number of objects in the cache.<a name="line.93"></a>
-<FONT color="green">094</FONT> * <a name="line.94"></a>
-<FONT color="green">095</FONT> * @return int The current number of objects in the cache.<a name="line.95"></a>
-<FONT color="green">096</FONT> */<a name="line.96"></a>
-<FONT color="green">097</FONT> int getNumberOfObjects();<a name="line.97"></a>
-<FONT color="green">098</FONT> <a name="line.98"></a>
-<FONT color="green">099</FONT> /**<a name="line.99"></a>
-<FONT color="green">100</FONT> * Flush the cache of all objects.<a name="line.100"></a>
-<FONT color="green">101</FONT> */<a name="line.101"></a>
-<FONT color="green">102</FONT> void flushCache();<a name="line.102"></a>
-<FONT color="green">103</FONT> }<a name="line.103"></a>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</PRE>
-</BODY>
-</HTML>
+<!DOCTYPE HTML>
+<html lang="de">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.cache;</a>
+<span class="sourceLineNo">002</span><a id="line.2"></a>
+<span class="sourceLineNo">003</span><a id="line.3">/*</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
+<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
+<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">011</span><a id="line.11"> *</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">013</span><a id="line.13"> *</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
+<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
+<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
+<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
+<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
+<span class="sourceLineNo">020</span><a id="line.20"> */</a>
+<span class="sourceLineNo">021</span><a id="line.21"></a>
+<span class="sourceLineNo">022</span><a id="line.22">import java.io.IOException;</a>
+<span class="sourceLineNo">023</span><a id="line.23">import java.util.List;</a>
+<span class="sourceLineNo">024</span><a id="line.24"></a>
+<span class="sourceLineNo">025</span><a id="line.25">/**</a>
+<span class="sourceLineNo">026</span><a id="line.26"> * GlobalCacheService interface.</a>
+<span class="sourceLineNo">027</span><a id="line.27"> *</a>
+<span class="sourceLineNo">028</span><a id="line.28"> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a></a>
+<span class="sourceLineNo">029</span><a id="line.29"> * @author <a href="mailto:peter@courefreshableCachedObjectux.biz">Peter CourefreshableCachedObjectux</a></a>
+<span class="sourceLineNo">030</span><a id="line.30"> * @version $Id: GlobalCacheService.java 1890075 2021-05-21 15:04:52Z painter $</a>
+<span class="sourceLineNo">031</span><a id="line.31"> */</a>
+<span class="sourceLineNo">032</span><a id="line.32">public interface GlobalCacheService</a>
+<span class="sourceLineNo">033</span><a id="line.33">{</a>
+<span class="sourceLineNo">034</span><a id="line.34"> /** Avalon role - used to id the component within the manager */</a>
+<span class="sourceLineNo">035</span><a id="line.35"> String ROLE = GlobalCacheService.class.getName();</a>
+<span class="sourceLineNo">036</span><a id="line.36"></a>
+<span class="sourceLineNo">037</span><a id="line.37"> /**</a>
+<span class="sourceLineNo">038</span><a id="line.38"> * Gets a cached object given its id (a String).</a>
+<span class="sourceLineNo">039</span><a id="line.39"> *</a>
+<span class="sourceLineNo">040</span><a id="line.40"> * @param <T> type of object to return</a>
+<span class="sourceLineNo">041</span><a id="line.41"> * @param objectId</a>
+<span class="sourceLineNo">042</span><a id="line.42"> * The String id for the object.</a>
+<span class="sourceLineNo">043</span><a id="line.43"> * @return A CachedObject.</a>
+<span class="sourceLineNo">044</span><a id="line.44"> * @throws ObjectExpiredException</a>
+<span class="sourceLineNo">045</span><a id="line.45"> * if the object has expired in the cache.</a>
+<span class="sourceLineNo">046</span><a id="line.46"> */</a>
+<span class="sourceLineNo">047</span><a id="line.47"> <T> CachedObject<T> getObject(String objectId) throws ObjectExpiredException;</a>
+<span class="sourceLineNo">048</span><a id="line.48"></a>
+<span class="sourceLineNo">049</span><a id="line.49"> /**</a>
+<span class="sourceLineNo">050</span><a id="line.50"> * Adds an object to the cache.</a>
+<span class="sourceLineNo">051</span><a id="line.51"> *</a>
+<span class="sourceLineNo">052</span><a id="line.52"> * @param <T> type of object to add</a>
+<span class="sourceLineNo">053</span><a id="line.53"> * @param objectId</a>
+<span class="sourceLineNo">054</span><a id="line.54"> * The String id for the object.</a>
+<span class="sourceLineNo">055</span><a id="line.55"> * @param object</a>
+<span class="sourceLineNo">056</span><a id="line.56"> * The object to add to the cache.</a>
+<span class="sourceLineNo">057</span><a id="line.57"> */</a>
+<span class="sourceLineNo">058</span><a id="line.58"> <T> void addObject(String objectId, CachedObject<T> object);</a>
+<span class="sourceLineNo">059</span><a id="line.59"></a>
+<span class="sourceLineNo">060</span><a id="line.60"> /**</a>
+<span class="sourceLineNo">061</span><a id="line.61"> * Removes an object from the cache.</a>
+<span class="sourceLineNo">062</span><a id="line.62"> *</a>
+<span class="sourceLineNo">063</span><a id="line.63"> * @param objectId</a>
+<span class="sourceLineNo">064</span><a id="line.64"> * The String id for the object.</a>
+<span class="sourceLineNo">065</span><a id="line.65"> */</a>
+<span class="sourceLineNo">066</span><a id="line.66"> void removeObject(String objectId);</a>
+<span class="sourceLineNo">067</span><a id="line.67"></a>
+<span class="sourceLineNo">068</span><a id="line.68"> /**</a>
+<span class="sourceLineNo">069</span><a id="line.69"> * Returns a copy of keys to objects in the cache as a list.</a>
+<span class="sourceLineNo">070</span><a id="line.70"> *</a>
+<span class="sourceLineNo">071</span><a id="line.71"> * Note that keys to expired objects are not returned.</a>
+<span class="sourceLineNo">072</span><a id="line.72"> *</a>
+<span class="sourceLineNo">073</span><a id="line.73"> * @return A List of <code>String</code>'s representing the keys to</a>
+<span class="sourceLineNo">074</span><a id="line.74"> * objects in the cache.</a>
+<span class="sourceLineNo">075</span><a id="line.75"> */</a>
+<span class="sourceLineNo">076</span><a id="line.76"> List<String> getKeys();</a>
+<span class="sourceLineNo">077</span><a id="line.77"></a>
+<span class="sourceLineNo">078</span><a id="line.78"> /**</a>
+<span class="sourceLineNo">079</span><a id="line.79"> * Returns a copy of the non-expired CachedObjects in the cache as a list.</a>
+<span class="sourceLineNo">080</span><a id="line.80"> *</a>
+<span class="sourceLineNo">081</span><a id="line.81"> * @return A List of <code>CachedObject</code> objects held in the cache</a>
+<span class="sourceLineNo">082</span><a id="line.82"> */</a>
+<span class="sourceLineNo">083</span><a id="line.83"> List<CachedObject<?>> getCachedObjects();</a>
+<span class="sourceLineNo">084</span><a id="line.84"></a>
+<span class="sourceLineNo">085</span><a id="line.85"> /**</a>
+<span class="sourceLineNo">086</span><a id="line.86"> * Returns the current size of the cache.</a>
+<span class="sourceLineNo">087</span><a id="line.87"> *</a>
+<span class="sourceLineNo">088</span><a id="line.88"> * @return int representing current cache size in number of bytes</a>
+<span class="sourceLineNo">089</span><a id="line.89"> * @throws IOException if unable to return cache size</a>
+<span class="sourceLineNo">090</span><a id="line.90"> */</a>
+<span class="sourceLineNo">091</span><a id="line.91"> int getCacheSize() throws IOException;</a>
+<span class="sourceLineNo">092</span><a id="line.92"></a>
+<span class="sourceLineNo">093</span><a id="line.93"> /**</a>
+<span class="sourceLineNo">094</span><a id="line.94"> * Returns the number of objects in the cache.</a>
+<span class="sourceLineNo">095</span><a id="line.95"> *</a>
+<span class="sourceLineNo">096</span><a id="line.96"> * @return int The current number of objects in the cache.</a>
+<span class="sourceLineNo">097</span><a id="line.97"> */</a>
+<span class="sourceLineNo">098</span><a id="line.98"> int getNumberOfObjects();</a>
+<span class="sourceLineNo">099</span><a id="line.99"></a>
+<span class="sourceLineNo">100</span><a id="line.100"> /**</a>
+<span class="sourceLineNo">101</span><a id="line.101"> * Flush the cache of all objects.</a>
+<span class="sourceLineNo">102</span><a id="line.102"> */</a>
+<span class="sourceLineNo">103</span><a id="line.103"> void flushCache();</a>
+<span class="sourceLineNo">104</span><a id="line.104">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
\ No newline at end of file
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/ObjectExpiredException.html
==============================================================================
--- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/ObjectExpiredException.html (original)
+++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/ObjectExpiredException.html Wed Aug 4 05:57:38 2021
@@ -1,102 +1,110 @@
-<HTML>
-<BODY BGCOLOR="white">
-<PRE>
-<FONT color="green">001</FONT> package org.apache.fulcrum.cache;<a name="line.1"></a>
-<FONT color="green">002</FONT> <a name="line.2"></a>
-<FONT color="green">003</FONT> /*<a name="line.3"></a>
-<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
-<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
-<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
-<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
-<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
-<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
-<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
-<FONT color="green">011</FONT> *<a name="line.11"></a>
-<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
-<FONT color="green">013</FONT> *<a name="line.13"></a>
-<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
-<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
-<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
-<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
-<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
-<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
-<FONT color="green">020</FONT> */<a name="line.20"></a>
-<FONT color="green">021</FONT> <a name="line.21"></a>
-<FONT color="green">022</FONT> /**<a name="line.22"></a>
-<FONT color="green">023</FONT> * Exception thrown when an item either does not exist or has expired from the<a name="line.23"></a>
-<FONT color="green">024</FONT> * GlobalCache.<a name="line.24"></a>
-<FONT color="green">025</FONT> * <a name="line.25"></a>
-<FONT color="green">026</FONT> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a><a name="line.26"></a>
-<FONT color="green">027</FONT> * @version $Id: ObjectExpiredException.java 670326 2008-06-22 09:31:47Z tv $<a name="line.27"></a>
-<FONT color="green">028</FONT> */<a name="line.28"></a>
-<FONT color="green">029</FONT> public class ObjectExpiredException extends Exception<a name="line.29"></a>
-<FONT color="green">030</FONT> {<a name="line.30"></a>
-<FONT color="green">031</FONT> <a name="line.31"></a>
-<FONT color="green">032</FONT> /**<a name="line.32"></a>
-<FONT color="green">033</FONT> * Serial version id<a name="line.33"></a>
-<FONT color="green">034</FONT> */<a name="line.34"></a>
-<FONT color="green">035</FONT> private static final long serialVersionUID = -4331535517388875678L;<a name="line.35"></a>
-<FONT color="green">036</FONT> }<a name="line.36"></a>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</PRE>
-</BODY>
-</HTML>
+<!DOCTYPE HTML>
+<html lang="de">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.cache;</a>
+<span class="sourceLineNo">002</span><a id="line.2"></a>
+<span class="sourceLineNo">003</span><a id="line.3">/*</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
+<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
+<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">011</span><a id="line.11"> *</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">013</span><a id="line.13"> *</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
+<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
+<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
+<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
+<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
+<span class="sourceLineNo">020</span><a id="line.20"> */</a>
+<span class="sourceLineNo">021</span><a id="line.21"></a>
+<span class="sourceLineNo">022</span><a id="line.22">/**</a>
+<span class="sourceLineNo">023</span><a id="line.23"> * Exception thrown when an item either does not exist or has expired from the</a>
+<span class="sourceLineNo">024</span><a id="line.24"> * GlobalCache.</a>
+<span class="sourceLineNo">025</span><a id="line.25"> * </a>
+<span class="sourceLineNo">026</span><a id="line.26"> * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a></a>
+<span class="sourceLineNo">027</span><a id="line.27"> * @version $Id: ObjectExpiredException.java 670326 2008-06-22 09:31:47Z tv $</a>
+<span class="sourceLineNo">028</span><a id="line.28"> */</a>
+<span class="sourceLineNo">029</span><a id="line.29">public class ObjectExpiredException extends Exception</a>
+<span class="sourceLineNo">030</span><a id="line.30">{</a>
+<span class="sourceLineNo">031</span><a id="line.31"></a>
+<span class="sourceLineNo">032</span><a id="line.32"> /**</a>
+<span class="sourceLineNo">033</span><a id="line.33"> * Serial version id</a>
+<span class="sourceLineNo">034</span><a id="line.34"> */</a>
+<span class="sourceLineNo">035</span><a id="line.35"> private static final long serialVersionUID = -4331535517388875678L;</a>
+<span class="sourceLineNo">036</span><a id="line.36">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
\ No newline at end of file
Modified: websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/Refreshable.html
==============================================================================
--- websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/Refreshable.html (original)
+++ websites/production/turbine/content/fulcrum/fulcrum-cache/apidocs/src-html/org/apache/fulcrum/cache/Refreshable.html Wed Aug 4 05:57:38 2021
@@ -1,101 +1,109 @@
-<HTML>
-<BODY BGCOLOR="white">
-<PRE>
-<FONT color="green">001</FONT> package org.apache.fulcrum.cache;<a name="line.1"></a>
-<FONT color="green">002</FONT> <a name="line.2"></a>
-<FONT color="green">003</FONT> /*<a name="line.3"></a>
-<FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
-<FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
-<FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a>
-<FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
-<FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
-<FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a>
-<FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
-<FONT color="green">011</FONT> *<a name="line.11"></a>
-<FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
-<FONT color="green">013</FONT> *<a name="line.13"></a>
-<FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
-<FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a>
-<FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
-<FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a>
-<FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a>
-<FONT color="green">019</FONT> * under the License.<a name="line.19"></a>
-<FONT color="green">020</FONT> */<a name="line.20"></a>
-<FONT color="green">021</FONT> <a name="line.21"></a>
-<FONT color="green">022</FONT> /**<a name="line.22"></a>
-<FONT color="green">023</FONT> * This is the interface for objects you want to refresh themselves from the<a name="line.23"></a>
-<FONT color="green">024</FONT> * cache.<a name="line.24"></a>
-<FONT color="green">025</FONT> * <a name="line.25"></a>
-<FONT color="green">026</FONT> * @author <a href="mailto:nissim@nksystems.com">Nissim Karpenstein</a><a name="line.26"></a>
-<FONT color="green">027</FONT> * @version $Id: Refreshable.java 670326 2008-06-22 09:31:47Z tv $<a name="line.27"></a>
-<FONT color="green">028</FONT> */<a name="line.28"></a>
-<FONT color="green">029</FONT> public interface Refreshable<a name="line.29"></a>
-<FONT color="green">030</FONT> {<a name="line.30"></a>
-<FONT color="green">031</FONT> /**<a name="line.31"></a>
-<FONT color="green">032</FONT> * Refreshes the object.<a name="line.32"></a>
-<FONT color="green">033</FONT> */<a name="line.33"></a>
-<FONT color="green">034</FONT> void refresh();<a name="line.34"></a>
-<FONT color="green">035</FONT> }<a name="line.35"></a>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-</PRE>
-</BODY>
-</HTML>
+<!DOCTYPE HTML>
+<html lang="de">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<main role="main">
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span><a id="line.1">package org.apache.fulcrum.cache;</a>
+<span class="sourceLineNo">002</span><a id="line.2"></a>
+<span class="sourceLineNo">003</span><a id="line.3">/*</a>
+<span class="sourceLineNo">004</span><a id="line.4"> * Licensed to the Apache Software Foundation (ASF) under one</a>
+<span class="sourceLineNo">005</span><a id="line.5"> * or more contributor license agreements. See the NOTICE file</a>
+<span class="sourceLineNo">006</span><a id="line.6"> * distributed with this work for additional information</a>
+<span class="sourceLineNo">007</span><a id="line.7"> * regarding copyright ownership. The ASF licenses this file</a>
+<span class="sourceLineNo">008</span><a id="line.8"> * to you under the Apache License, Version 2.0 (the</a>
+<span class="sourceLineNo">009</span><a id="line.9"> * "License"); you may not use this file except in compliance</a>
+<span class="sourceLineNo">010</span><a id="line.10"> * with the License. You may obtain a copy of the License at</a>
+<span class="sourceLineNo">011</span><a id="line.11"> *</a>
+<span class="sourceLineNo">012</span><a id="line.12"> * http://www.apache.org/licenses/LICENSE-2.0</a>
+<span class="sourceLineNo">013</span><a id="line.13"> *</a>
+<span class="sourceLineNo">014</span><a id="line.14"> * Unless required by applicable law or agreed to in writing,</a>
+<span class="sourceLineNo">015</span><a id="line.15"> * software distributed under the License is distributed on an</a>
+<span class="sourceLineNo">016</span><a id="line.16"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
+<span class="sourceLineNo">017</span><a id="line.17"> * KIND, either express or implied. See the License for the</a>
+<span class="sourceLineNo">018</span><a id="line.18"> * specific language governing permissions and limitations</a>
+<span class="sourceLineNo">019</span><a id="line.19"> * under the License.</a>
+<span class="sourceLineNo">020</span><a id="line.20"> */</a>
+<span class="sourceLineNo">021</span><a id="line.21"></a>
+<span class="sourceLineNo">022</span><a id="line.22">/**</a>
+<span class="sourceLineNo">023</span><a id="line.23"> * This is the interface for objects you want to refresh themselves from the</a>
+<span class="sourceLineNo">024</span><a id="line.24"> * cache.</a>
+<span class="sourceLineNo">025</span><a id="line.25"> * </a>
+<span class="sourceLineNo">026</span><a id="line.26"> * @author <a href="mailto:nissim@nksystems.com">Nissim Karpenstein</a></a>
+<span class="sourceLineNo">027</span><a id="line.27"> * @version $Id: Refreshable.java 670326 2008-06-22 09:31:47Z tv $</a>
+<span class="sourceLineNo">028</span><a id="line.28"> */</a>
+<span class="sourceLineNo">029</span><a id="line.29">public interface Refreshable</a>
+<span class="sourceLineNo">030</span><a id="line.30">{</a>
+<span class="sourceLineNo">031</span><a id="line.31"> /**</a>
+<span class="sourceLineNo">032</span><a id="line.32"> * Refreshes the object.</a>
+<span class="sourceLineNo">033</span><a id="line.33"> */</a>
+<span class="sourceLineNo">034</span><a id="line.34"> void refresh();</a>
+<span class="sourceLineNo">035</span><a id="line.35">}</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</main>
+</body>
+</html>
\ No newline at end of file