http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributes.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributes.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributes.html new file mode 100644 index 0000000..f4a8db4 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributes.html @@ -0,0 +1,1073 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>EvictionAttributes (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="EvictionAttributes (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":10,"i16":6,"i17":6,"i18":6,"i19":6,"i20":10,"i21":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/EvictionAttributes.html" target="_top">Frames</a></li> +<li><a href="EvictionAttributes.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire.cache</div> +<h2 title="Class EvictionAttributes" class="title">Class EvictionAttributes</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.gemstone.gemfire.cache.EvictionAttributes</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">EvictionAttributes</span> +extends java.lang.Object +implements <a href="../../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></pre> +<div class="block"><p>Attributes that describe how a <code>Region</code>'s size is managed through an eviction controller. Eviction + controllers are defined by an <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> and a <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAction</code></a>. Once a <code>Region</code> is created with an eviction controller, it can + not be removed, however it can be changed through an <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><code>EvictionAttributesMutator</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/AttributesFactory.html#setEvictionAttributes-com.gemstone.gemfire.cache.EvictionAttributes-"><code>AttributesFactory.setEvictionAttributes(EvictionAttributes)</code></a>, +<a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><code>AttributesMutator</code></a>, +<a href="../../../../serialized-form.html#com.gemstone.gemfire.cache.EvictionAttributes">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.com.gemstone.gemfire.DataSerializable"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></h3> +<code><a href="../../../../com/gemstone/gemfire/DataSerializable.Replaceable.html" title="interface in com.gemstone.gemfire">DataSerializable.Replaceable</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">DEFAULT_ENTRIES_MAXIMUM</a></span></code> +<div class="block">The default maximum for <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">DEFAULT_MEMORY_MAXIMUM</a></span></code> +<div class="block">The default maximum for <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#EvictionAttributes--">EvictionAttributes</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLIFOEntryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-">createLIFOEntryAttributes</a></span>(int maximumEntries, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLIFOMemoryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-">createLIFOMemoryAttributes</a></span>(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes--">createLRUEntryAttributes</a></span>()</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes-com.gemstone.gemfire.cache.EvictionAction-">createLRUEntryAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a> + and given <code>evictionAction</code>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes-int-">createLRUEntryAttributes</a></span>(int maximumEntries)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and given <code>maximumEntries</code>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-">createLRUEntryAttributes</a></span>(int maximumEntries, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with given <code>evictionAction</code> + and given <code>maximumEntries</code>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUHeapAttributes--">createLRUHeapAttributes</a></span>()</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUHeapAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-">createLRUHeapAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and the given <code>sizer</code>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUHeapAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-">createLRUHeapAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with the given <code>evictionAction</code> + and given <code>sizer</code>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--">createLRUMemoryAttributes</a></span>()</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes-int-">createLRUMemoryAttributes</a></span>(int maximumMegabytes)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and given <code>maximumMegabytes</code>.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes-int-com.gemstone.gemfire.cache.util.ObjectSizer-">createLRUMemoryAttributes</a></span>(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code>.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes-int-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-">createLRUMemoryAttributes</a></span>(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with the given <code>evictionAction</code>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-">createLRUMemoryAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-">createLRUMemoryAttributes</a></span>(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</code> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with given <code>evictionAction</code>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#getAction--">getAction</a></span>()</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache">EvictionAlgorithm</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#getAlgorithm--">getAlgorithm</a></span>()</code> +<div class="block">The algorithm is used to identify entries that will be evicted.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>abstract int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#getMaximum--">getMaximum</a></span>()</code> +<div class="block">The unit of this value is determined by the definition of the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> set by one of the creation + methods e.g.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#getObjectSizer--">getObjectSizer</a></span>()</code> +<div class="block">An <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util"><code>ObjectSizer</code></a> is used by the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY"><code>EvictionAlgorithm.LRU_MEMORY</code></a> algorithm to measure the size of each + Entry as it is entered into a Region.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.com.gemstone.gemfire.DataSerializable"> +<!-- --> +</a> +<h3>Methods inherited from interface com.gemstone.gemfire.<a href="../../../../com/gemstone/gemfire/DataSerializable.html" title="interface in com.gemstone.gemfire">DataSerializable</a></h3> +<code><a href="../../../../com/gemstone/gemfire/DataSerializable.html#fromData-java.io.DataInput-">fromData</a>, <a href="../../../../com/gemstone/gemfire/DataSerializable.html#toData-java.io.DataOutput-">toData</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_ENTRIES_MAXIMUM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_ENTRIES_MAXIMUM</h4> +<pre>public static final int DEFAULT_ENTRIES_MAXIMUM</pre> +<div class="block">The default maximum for <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a>. Currently <code>900</code> entries.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#com.gemstone.gemfire.cache.EvictionAttributes.DEFAULT_ENTRIES_MAXIMUM">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_MEMORY_MAXIMUM"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_MEMORY_MAXIMUM</h4> +<pre>public static final int DEFAULT_MEMORY_MAXIMUM</pre> +<div class="block">The default maximum for <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a>. Currently <code>10</code> megabytes.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#com.gemstone.gemfire.cache.EvictionAttributes.DEFAULT_MEMORY_MAXIMUM">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="EvictionAttributes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EvictionAttributes</h4> +<pre>public EvictionAttributes()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createLRUEntryAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUEntryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUEntryAttributes()</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a>. + <p/> + <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAttributes</code></a> cause regions to evict the least recently used (LRU) + entry once the region reaches a maximum capacity. The entry is either locally destroyed or its value overflows + to disk when evicted. + <p/> + <p/> + This is not supported when replication is enabled. + <p/> + <p/> + For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, the EvictionAttribute <code>maximum</code>, indicates the number of + entries allowed in the region, collectively for its primary buckets and redundant copies for this JVM. Once there + are <code>maximum</code> entries in the region's primary buckets and redundant copies for this JVM, the least + recently used entry will be evicted from the bucket in which the subsequent put takes place. + <p/> + <p/> + If you are using a <code>cache.xml</code> file to create a Cache Region declaratively, you can include the + following to configure a region for eviction + <p/> + <pre> + <region-attributes> + <eviction-attributes> + <lru-entry-count maximum="900" action="local-destroy"/> + </eviction-attributes> + </region-attributes> + </pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a></dd> +</dl> +</li> +</ul> +<a name="createLRUEntryAttributes-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUEntryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUEntryAttributes(int maximumEntries)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and given <code>maximumEntries</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximumEntries</code> - the number of entries to keep in the Region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and <code>maximumEntries</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes--"><code>createLRUEntryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUEntryAttributes-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUEntryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUEntryAttributes(<a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a> + and given <code>evictionAction</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>evictionAction</code> - the action to perform when evicting an entry</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_ENTRIES_MAXIMUM">maximum</a> + and given <code>evictionAction</code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>8.1</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes--"><code>createLRUEntryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUEntryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUEntryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUEntryAttributes(int maximumEntries, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with given <code>evictionAction</code> + and given <code>maximumEntries</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximumEntries</code> - the number of entries to keep in the Region</dd> +<dd><code>evictionAction</code> - the action to perform when evicting an entry</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_ENTRY">entry LRU</a> eviction attributes + with given <code>evictionAction</code> + and given <code>maximumEntries</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes--"><code>createLRUEntryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUHeapAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUHeapAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUHeapAttributes()</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>. + <p/> + Heap LRU EvictionAttributes evict the least recently used <a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html" title="interface in com.gemstone.gemfire.cache"><code>Region.Entry</code></a> when heap usage exceeds the + <a href="../../../../com/gemstone/gemfire/cache/control/ResourceManager.html" title="interface in com.gemstone.gemfire.cache.control"><code>ResourceManager</code></a> eviction heap threshold. If the eviction heap threshold is exceeded the least recently used + <a href="../../../../com/gemstone/gemfire/cache/Region.Entry.html" title="interface in com.gemstone.gemfire.cache"><code>Region.Entry</code></a>s are evicted. + <p/> + <p/> + With other LRU-based eviction controllers, only cache actions (such as <a href="../../../../com/gemstone/gemfire/cache/Region.html#put-K-V-"><code>puts</code></a> and + <a href="../../../../com/gemstone/gemfire/cache/Region.html#get-java.lang.Object-"><code>gets</code></a>) cause the LRU entry to be evicted. However, with heap LRU, because the JVM's heap may be effected + by more than just the GemFire cache operations, a daemon thread will perform the eviction if no operations are being done + on the region. + <p/> + The eviction attribute's <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">sizer</a> is used to estimate how much the heap will be reduced by an + eviction. + <p/> + When using Heap LRU, the JVM must be launched with the <code>-Xmx</code> and <code>-Xms</code> switches set to the + same values. Many virtual machine implementations have additional JVM switches to control the behavior of the + garbage collector. We suggest that you investigate tuning the garbage collector when using this type of eviction + controller. A collector that frequently collects is needed to keep our heap usage up to date. In particular, on + the Sun <A href="http://java.sun.com/docs/hotspot/gc/index.html";>HotSpot</a> JVM, the + <code>-XX:+UseConcMarkSweepGC</code> flag needs to be set, and <code>-XX:CMSInitiatingOccupancyFraction=N</code> + should be set with N being a percentage that is less than the <a href="../../../../com/gemstone/gemfire/cache/control/ResourceManager.html" title="interface in com.gemstone.gemfire.cache.control"><code>ResourceManager</code></a> eviction heap threshold. + <p/> + The JRockit JVM has similar flags, <code>-Xgc:gencon</code> and <code>-XXgcTrigger:N</code>, which are required if + using this LRU algorithm. Please Note: the JRockit gcTrigger flag is based on heap free, not heap in use like the + GemFire parameter. This means you need to set gcTrigger to 100-N. for example, if your eviction threshold is 30 + percent, you will need to set gcTrigger to 70 percent. + <p/> + On the IBM JVM, the flag to get a similar collector is <code>-Xgcpolicy:gencon</code>, but there is no corollary to + the gcTrigger/CMSInitiatingOccupancyFraction flags, so when using this feature with an IBM JVM, the heap usage + statistics might lag the true memory usage of the JVM, and thresholds may need to be set sufficiently high that the + JVM will initiate GC before the thresholds are crossed. + <p/> + If you are using a <code>cache.xml</code> file to create a Cache Region declaratively, you can include the + following to create an LRU heap eviction controller: + <p/> + <pre> + <region-attributes> + <eviction-attributes> + <lru-heap-percentage action="local-destroy" + </eviction-attributes> + </region-attributes> + </pre> + <p/></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a></dd> +</dl> +</li> +</ul> +<a name="createLRUHeapAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUHeapAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUHeapAttributes(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and the given <code>sizer</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sizer</code> - the sizer implementation used to determine the size of each entry in this region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a> + and the given <code>sizer</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUHeapAttributes--"><code>createLRUHeapAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUHeapAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUHeapAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUHeapAttributes(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with the given <code>evictionAction</code> + and given <code>sizer</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sizer</code> - the sizer implementation used to determine the size of each entry in this region</dd> +<dd><code>evictionAction</code> - the way in which entries should be evicted</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP">heap LRU</a> eviction attributes + with the given <code>evictionAction</code> + and given <code>sizer</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUHeapAttributes--"><code>createLRUHeapAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes()</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>. + <p/> + Creates EvictionAttributes for an eviction controller that will remove the least recently used (LRU) entry from a + region once the region reaches a certain byte capacity. Capacity is determined by monitoring the size of entries + added and evicted. Capacity is specified in terms of megabytes. GemFire uses an efficient algorithm to determine + the amount of space a region entry occupies in the JVM. However, this algorithm may not yield optimal results for + all kinds of data. The user may provide his or her own algorithm for determining the size of objects by + implementing an <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util"><code>ObjectSizer</code></a>. + <p/> + <p/> + For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, the EvictionAttribute <code>maximum</code>, is always equal to + <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max memory "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>. It signifies the amount of memory allowed in the region, collectively for its primary buckets + and redundant copies for this JVM. It can be different for the same region in different JVMs. + <p/> + If you are using a <code>cache.xml</code> file to create a Cache Region declaratively, you can include the + following to create an LRU memory eviction controller: + <p/> + <pre> + <region-attributes> + <eviction-attributes> + <lru-memory-size maximum="10" action="local-destroy"> + <class-name>com.foo.MySizer</class-name> + <parameter name="name"> + <string>Super Sizer</string> + </parameter> + </lru-memory-size> + </eviction-attributes> + </region-attributes> + </pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes(int maximumMegabytes)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and given <code>maximumMegabytes</code>. + <p/> + <p/> + For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, even if maximumMegabytes are supplied, the EvictionAttribute + <code>maximum</code>, is always set to <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max memory + "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>. + <p/></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximumMegabytes</code> - the maximum allowed bytes in the Region</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + default <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html#DEFAULT">sizer</a>, + and given <code>maximumMegabytes</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes-int-com.gemstone.gemfire.cache.util.ObjectSizer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code>. + <p/> + <p>For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, even if maximumMegabytes are supplied, the EvictionAttribute + <code>maximum</code>, is always set to <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max + memory "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximumMegabytes</code> - the maximum allowed bytes in the Region</dd> +<dd><code>sizer</code> - calculates the size in bytes of the key and value for an entry.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes-int-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with the given <code>evictionAction</code>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code>. + <p/> + <p>For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, even if maximumMegabytes are supplied, the EvictionAttribute + <code>maximum</code>, is always set to <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max + memory "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximumMegabytes</code> - the maximum allowed bytes in the Region</dd> +<dd><code>sizer</code> - calculates the size in bytes of the key and value for an entry.</dd> +<dd><code>evictionAction</code> - the action to take when the maximum has been reached.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with the given <code>evictionAction</code>, + given <code>sizer</code>, + and given <code>maximumMegabytes</code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>. + <p/> + <p>For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, even if maximumMegabytes are supplied, the EvictionAttribute + <code>maximum</code>, is always set to <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max + memory "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sizer</code> - calculates the size in bytes of the key and value for an entry.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with default <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html#DEFAULT_EVICTION_ACTION">action</a>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="createLRUMemoryAttributes-com.gemstone.gemfire.cache.util.ObjectSizer-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLRUMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLRUMemoryAttributes(<a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> sizer, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<div class="block">Creates and returns <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with given <code>evictionAction</code>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a>. + <p/> + <p>For a region with <a href="../../../../com/gemstone/gemfire/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a>, even if maximumMegabytes are supplied, the EvictionAttribute + <code>maximum</code>, is always set to <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributesFactory.html#setLocalMaxMemory-int-"><code>" local max + memory "</code></a> specified for the <a href="../../../../com/gemstone/gemfire/cache/PartitionAttributes.html" title="interface in com.gemstone.gemfire.cache"><code>PartitionAttributes</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>sizer</code> - calculates the size in bytes of the key and value for an entry.</dd> +<dd><code>evictionAction</code> - the action to take when the maximum has been reached.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY">memory LRU</a> eviction attributes + with given <code>evictionAction</code>, + given <code>sizer</code>, + and default <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#DEFAULT_MEMORY_MAXIMUM">maximum</a></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>6.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a></dd> +</dl> +</li> +</ul> +<a name="getObjectSizer--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObjectSizer</h4> +<pre>public abstract <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util">ObjectSizer</a> getObjectSizer()</pre> +<div class="block">An <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util"><code>ObjectSizer</code></a> is used by the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY"><code>EvictionAlgorithm.LRU_MEMORY</code></a> algorithm to measure the size of each + Entry as it is entered into a Region. A default implementation is provided, see <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUMemoryAttributes--"><code>createLRUMemoryAttributes()</code></a> for more. + An <a href="../../../../com/gemstone/gemfire/cache/util/ObjectSizer.html" title="interface in com.gemstone.gemfire.cache.util"><code>ObjectSizer</code></a> is used by <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a> to estimate how much heap will be saved + when evicting a region entry.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the sizer used by <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_MEMORY"><code>EvictionAlgorithm.LRU_MEMORY</code></a> or <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html#LRU_HEAP"><code>EvictionAlgorithm.LRU_HEAP</code></a>, for all other algorithms null is returned.</dd> +</dl> +</li> +</ul> +<a name="getAlgorithm--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlgorithm</h4> +<pre>public abstract <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache">EvictionAlgorithm</a> getAlgorithm()</pre> +<div class="block">The algorithm is used to identify entries that will be evicted.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a non-null EvictionAlgorithm instance reflecting the configured value or NONE when no eviction controller + has been configured.</dd> +</dl> +</li> +</ul> +<a name="getMaximum--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaximum</h4> +<pre>public abstract int getMaximum()</pre> +<div class="block">The unit of this value is determined by the definition of the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> set by one of the creation + methods e.g. <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html#createLRUEntryAttributes--"><code>createLRUEntryAttributes()</code></a></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>maximum value used by the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> which determines when the <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAction</code></a> is + performed.</dd> +</dl> +</li> +</ul> +<a name="getAction--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAction</h4> +<pre>public abstract <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> getAction()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>action that the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> takes when the maximum value is reached.</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public final boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public final int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="createLIFOEntryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLIFOEntryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLIFOEntryAttributes(int maximumEntries, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an EvictionAttributes for the LIFOCapacityController</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.7</dd> +</dl> +</li> +</ul> +<a name="createLIFOMemoryAttributes-int-com.gemstone.gemfire.cache.EvictionAction-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createLIFOMemoryAttributes</h4> +<pre>public static <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache">EvictionAttributes</a> createLIFOMemoryAttributes(int maximumMegabytes, + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache">EvictionAction</a> evictionAction)</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an EvictionAttributes for the MemLIFOCapacityController</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.7</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributesMutator.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/EvictionAttributes.html" target="_top">Frames</a></li> +<li><a href="EvictionAttributes.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/54a3e718/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributesMutator.html ---------------------------------------------------------------------- diff --git a/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributesMutator.html b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributesMutator.html new file mode 100644 index 0000000..1079e53 --- /dev/null +++ b/releases/1.0.0-incubating.M2-SNAPSHOT/javadocs/com/gemstone/gemfire/cache/EvictionAttributesMutator.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_45) on Fri Mar 11 16:13:08 PST 2016 --> +<title>EvictionAttributesMutator (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)</title> +<meta name="date" content="2016-03-11"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="EvictionAttributesMutator (Apache Geode 1.0.0-incubating.M2-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/EvictionAttributesMutator.html" target="_top">Frames</a></li> +<li><a href="EvictionAttributesMutator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.gemstone.gemfire.cache</div> +<h2 title="Interface EvictionAttributesMutator" class="title">Interface EvictionAttributesMutator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">EvictionAttributesMutator</span></pre> +<div class="block">The EvictionAttributesMutator allows changes to be made to a + <a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAttributes</code></a>. It is returned + by <a href="../../../../com/gemstone/gemfire/cache/AttributesMutator.html#getEvictionAttributesMutator--"><code>AttributesMutator.getEvictionAttributesMutator()</code></a></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>5.0</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributesMutator.html#setMaximum-int-">setMaximum</a></span>(int maximum)</code> +<div class="block">Sets the maximum value on the <code>EvictionAttributesImpl</code> that the given + <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> uses to determine when to perform its + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAction</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setMaximum-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMaximum</h4> +<pre>void setMaximum(int maximum)</pre> +<div class="block">Sets the maximum value on the <code>EvictionAttributesImpl</code> that the given + <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a> uses to determine when to perform its + <a href="../../../../com/gemstone/gemfire/cache/EvictionAction.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAction</code></a>. The unit of the maximum value is determined by the + <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximum</code> - value used by the <a href="../../../../com/gemstone/gemfire/cache/EvictionAlgorithm.html" title="class in com.gemstone.gemfire.cache"><code>EvictionAlgorithm</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionAttributes.html" title="class in com.gemstone.gemfire.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/gemstone/gemfire/cache/EvictionCriteria.html" title="interface in com.gemstone.gemfire.cache"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/gemstone/gemfire/cache/EvictionAttributesMutator.html" target="_top">Frames</a></li> +<li><a href="EvictionAttributesMutator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
