Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html
blob: 2a4044665c5a052c288ea13c7847bf530c07c530 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util.html">Util</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_util_1_1_cache.html">Cache</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html">Cache< TKey, TValue ></a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for cache implementations.
<a href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#details">More...</a></p>
<p>Inherits IDisposable.</p>
<p>Inherited by Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.SynchronizedCache_Renamed_Class, and <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_map_cache_3_01_t_key_00_01_t_value_01_4.html">Lucene.Net.Util.Cache.SimpleMapCache&lt; TKey, TValue &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><b>SynchronizedCache_Renamed_Class</b></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Simple <a class="el" href="namespace_lucene_1_1_net_1_1_util_1_1_cache.html">Cache</a> wrapper that synchronizes all calls that access the cache. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1ac4d7b8c528db322013e751bd8a78ab"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a1ac4d7b8c528db322013e751bd8a78ab">Put</a> (TKey key, TValue value_Renamed)</td></tr>
<tr class="memdesc:a1ac4d7b8c528db322013e751bd8a78ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Puts a (key, value)-pair into the cache. <a href="#a1ac4d7b8c528db322013e751bd8a78ab"></a><br/></td></tr>
<tr class="separator:a1ac4d7b8c528db322013e751bd8a78ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5938d4d2695aae16b6da67af35776960"><td class="memItemLeft" align="right" valign="top">abstract TValue&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a5938d4d2695aae16b6da67af35776960">Get</a> (System.Object key)</td></tr>
<tr class="memdesc:a5938d4d2695aae16b6da67af35776960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value for the given key. <a href="#a5938d4d2695aae16b6da67af35776960"></a><br/></td></tr>
<tr class="separator:a5938d4d2695aae16b6da67af35776960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a280a49a707e2bc28406da2ec30f6171a"><td class="memItemLeft" align="right" valign="top">abstract bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a280a49a707e2bc28406da2ec30f6171a">ContainsKey</a> (System.Object key)</td></tr>
<tr class="memdesc:a280a49a707e2bc28406da2ec30f6171a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the given key is in this cache. <a href="#a280a49a707e2bc28406da2ec30f6171a"></a><br/></td></tr>
<tr class="separator:a280a49a707e2bc28406da2ec30f6171a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39630194977a6a3087d234cac1adb377"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a39630194977a6a3087d234cac1adb377">Close</a> ()</td></tr>
<tr class="memdesc:a39630194977a6a3087d234cac1adb377"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the cache. <a href="#a39630194977a6a3087d234cac1adb377"></a><br/></td></tr>
<tr class="separator:a39630194977a6a3087d234cac1adb377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58fa0207adc15e471d5517d6fd1257fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a58fa0207adc15e471d5517d6fd1257fb">Dispose</a> ()</td></tr>
<tr class="separator:a58fa0207adc15e471d5517d6fd1257fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a6773369e9b949a49f2f11e38a85c7574"><td class="memItemLeft" align="right" valign="top">static Cache&lt; TKey, TValue &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a6773369e9b949a49f2f11e38a85c7574">SynchronizedCache</a> (Cache&lt; TKey, TValue &gt; cache)</td></tr>
<tr class="memdesc:a6773369e9b949a49f2f11e38a85c7574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a thread-safe cache backed by the specified cache. In order to guarantee thread-safety, all access to the backed cache must be accomplished through the returned cache. <a href="#a6773369e9b949a49f2f11e38a85c7574"></a><br/></td></tr>
<tr class="separator:a6773369e9b949a49f2f11e38a85c7574"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a79df638c13db4d9a5aa4d9f95f9e359b"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_cache_3_01_t_key_00_01_t_value_01_4.html#a79df638c13db4d9a5aa4d9f95f9e359b">Dispose</a> (bool disposing)</td></tr>
<tr class="separator:a79df638c13db4d9a5aa4d9f95f9e359b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for cache implementations.</p>
<p>Definition at line <a class="el" href="_cache_8cs_source.html#l00025">25</a> of file <a class="el" href="_cache_8cs_source.html">Cache.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a39630194977a6a3087d234cac1adb377"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the cache.</p>
<p>Definition at line <a class="el" href="_cache_8cs_source.html#l00117">117</a> of file <a class="el" href="_cache_8cs_source.html">Cache.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a280a49a707e2bc28406da2ec30f6171a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract bool Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.ContainsKey </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the given key is in this cache. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_map_cache_3_01_t_key_00_01_t_value_01_4.html#a59a5533ea7bed6bb42511d1958bbfa57">Lucene.Net.Util.Cache.SimpleMapCache&lt; TKey, TValue &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="a58fa0207adc15e471d5517d6fd1257fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.Dispose </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_cache_8cs_source.html#l00122">122</a> of file <a class="el" href="_cache_8cs_source.html">Cache.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a79df638c13db4d9a5aa4d9f95f9e359b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.Dispose </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>disposing</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_map_cache_3_01_t_key_00_01_t_value_01_4.html#a4784aeb472b316f1e87d9f6fd95677d2">Lucene.Net.Util.Cache.SimpleMapCache&lt; TKey, TValue &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="a5938d4d2695aae16b6da67af35776960"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract TValue Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.Get </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value for the given key. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_map_cache_3_01_t_key_00_01_t_value_01_4.html#af5e4d47225d9598287b6cdd10b7160f8">Lucene.Net.Util.Cache.SimpleMapCache&lt; TKey, TValue &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="a1ac4d7b8c528db322013e751bd8a78ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.Put </td>
<td>(</td>
<td class="paramtype">TKey&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TValue&#160;</td>
<td class="paramname"><em>value_Renamed</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Puts a (key, value)-pair into the cache. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_l_r_u_cache_3_01_t_key_00_01_t_value_01_4.html#ab553a35a96045f34d42501f0cadb0b9e">Lucene.Net.Util.Cache.SimpleLRUCache&lt; TKey, TValue &gt;</a>, and <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_cache_1_1_simple_map_cache_3_01_t_key_00_01_t_value_01_4.html#a25c15b5036164682e90bb2cc31a7b62a">Lucene.Net.Util.Cache.SimpleMapCache&lt; TKey, TValue &gt;</a>.</p>
</div>
</div>
<a class="anchor" id="a6773369e9b949a49f2f11e38a85c7574"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Cache&lt;TKey, TValue&gt; Lucene.Net.Util.Cache.Cache&lt; TKey, TValue &gt;.SynchronizedCache </td>
<td>(</td>
<td class="paramtype">Cache&lt; TKey, TValue &gt;&#160;</td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a thread-safe cache backed by the specified cache. In order to guarantee thread-safety, all access to the backed cache must be accomplished through the returned cache. </p>
<p>Definition at line <a class="el" href="_cache_8cs_source.html#l00090">90</a> of file <a class="el" href="_cache_8cs_source.html">Cache.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Util/Cache/<a class="el" href="_cache_8cs_source.html">Cache.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>