diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/capability/ShutdownCapability.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/capability/ShutdownCapability.html | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html new file mode 100644 index 0000000..278f1da --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html @@ -0,0 +1,277 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ShutdownCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ShutdownCapability (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ShutdownCapability.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.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/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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.amazon.carbonado.capability</div> +<h2 title="Interface ShutdownCapability" class="title">Interface ShutdownCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ShutdownCapability</span> +extends <a href="../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled</a></strong>()</code> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled</a></strong>(boolean enabled)</code> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown</a></strong>()</code> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</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="isAutoShutdownEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoShutdownEnabled</h4> +<pre>boolean isAutoShutdownEnabled()</pre> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</li> +</ul> +<a name="setAutoShutdownEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoShutdownEnabled</h4> +<pre>void setAutoShutdownEnabled(boolean enabled)</pre> +<div class="block">Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</dd></dl> +</li> +</ul> +<a name="shutdown()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shutdown</h4> +<pre>void shutdown()</pre> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively <i>suspending</i> any + threads which continue to interact with this repository. <b>For this + reason, this method should only ever be called during a virtual machine + shutdown.</b> + + <p>Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.SecurityException</code> - if caller does not have permission</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ShutdownCapability.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.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/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/capability/ShutdownCapability.html" target="_top">Frames</a></li> +<li><a href="ShutdownCapability.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 ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |