From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../carbonado/capability/ShutdownCapability.html | 277 +++++++++++++++++++++ 1 file changed, 277 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/capability/ShutdownCapability.html (limited to 'apidocs/com/amazon/carbonado/capability/ShutdownCapability.html') 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 @@ + + + + + + +ShutdownCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface ShutdownCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractRepository
    +
    +
    +
    +
    public interface ShutdownCapability
+extends Capability
    +
    Capability for repositories that require special attention with the Java + virtual machine exits.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisAutoShutdownEnabled() +
      Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
      +
      voidsetAutoShutdownEnabled(boolean enabled) +
      Request to enable or disable the automatic shutdown hook.
      +
      voidshutdown() +
      Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isAutoShutdownEnabled

        +
        boolean isAutoShutdownEnabled()
        +
        Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
        +
        • +
      + + + +
        +
      • +

        setAutoShutdownEnabled

        +
        void setAutoShutdownEnabled(boolean enabled)
        +
        Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.
        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        void shutdown()
        +
        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 suspending any + threads which continue to interact with this repository. For this + reason, this method should only ever be called during a virtual machine + shutdown. + +

        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.

        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3