diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/index-files/index-20.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-20.html')
| -rw-r--r-- | apidocs/index-files/index-20.html | 611 |
1 files changed, 611 insertions, 0 deletions
diff --git a/apidocs/index-files/index-20.html b/apidocs/index-files/index-20.html new file mode 100644 index 0000000..df53699 --- /dev/null +++ b/apidocs/index-files/index-20.html @@ -0,0 +1,611 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>T-Index (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="T-Index (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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-19.html">Prev Letter</a></li> +<li><a href="index-21.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-20.html" target="_top">Frames</a></li> +<li><a href="index-20.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_T_"> +<!-- --> +</a> +<h2 class="title">T</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">TaskQueueThread</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Simple generic queue for running tasks from a single thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int)">TaskQueueThread(String, int)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int, long)">TaskQueueThread(String, int, long)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TextAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Converts database Blobs and Clobs to Strings.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TextAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TextAdapter)">TextAdapter.Adapter(Class<?>, String, TextAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.lang.String)">TextAdapter.Adapter(Class<?>, String, String)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset)">TextAdapter.Adapter(Class<?>, String, Charset)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset, java.nio.charset.Charset[])">TextAdapter.Adapter(Class<?>, String, Charset, Charset[])</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">TextConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">TextConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.TextConstraint)">TextConstraint.Constraint(Class<?>, String, TextConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, java.lang.String[], java.lang.String[])">TextConstraint.Constraint(Class<?>, String, String[], String[])</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#the()">the()</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Returns the empty cursor instance.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Throttle</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">General purpose class for throttling work relative to its actual measured + performance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Throttle.html#Throttle(int)">Throttle(int)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Throttle.html#throttle(double, long)">throttle(double, long)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ThrottledCursor</span></a><<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#ThrottledCursor(com.amazon.carbonado.Cursor, double)">ThrottledCursor(Cursor<S>, double)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwConcatException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String...)">throwConcatException(CodeBuilder, Class, String...)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to throw an exception with a message concatenated at runtime.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String)">throwException(CodeBuilder, Class, String)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to throw an exception with an optional message.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util"><span class="strong">ThrowUnchecked</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use <code>ThrowUnchecked</code> instead</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#ThrowUnchecked()">ThrowUnchecked()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Notification that createReal is taking too long.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.From.html#to(java.lang.Class)">to(Class<T>)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_KEY_ONLY_METHOD_NAME">TO_STRING_KEY_ONLY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_METHOD_NAME">TO_STRING_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#toCharacter()">toCharacter()</a></span> - Method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException(Throwable)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate FetchException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException(String)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate FetchException, prepending + the specified message.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toFetchException(java.lang.Throwable)">toFetchException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toFirst()">toFirst()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the first available entry.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toFirst(byte[])">toFirst(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the first available entry at or after the given + key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toLast()">toLast()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the last available entry.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toLast(byte[])">toLast(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the last available entry at or before the given + key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#toList()">toList()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#toList(int)">toList(int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNext()">toNext()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next available entry, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNext(int)">toNext(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next available entry, incrementing by the amount + given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNextKey()">toNextKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next unique key, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException(Throwable)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate PersistException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException(String)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate PersistException, prepending + the specified message.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toPersistException(java.lang.Throwable)">toPersistException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPrevious()">toPrevious()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous available entry, returning false if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPrevious(int)">toPrevious(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous available entry, decrementing by the + amount given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPreviousKey()">toPreviousKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous unique key, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toRepositoryException(java.lang.Throwable)">toRepositoryException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate repository + exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the string value of the filter with any values substituted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/RelOp.html#toString()">toString()</a></span> - Method in enum com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></dt> +<dd> +<div class="block">Returns one of "=", "!=", "<", ">=", ">", or "<=".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the chained property formatted as "name.subname.subsubname".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns the chained property in a parseable form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> +<div class="block">Implementation calls appendTo.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a description of the query filter and any other arguments.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a string for debugging purposes that contains all supported + property names and values for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a string for debugging purposes that contains supported key + property names and values for this object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Transaction</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#transactionManager()">transactionManager()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Returns the repository's TransactionManager.</div> +</dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionManager</span></a><<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Generic transaction manager for repositories.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager()">TransactionManager()</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)">TransactionManager(TransactionMonitor)</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">TransactionMonitor</span></a> - Interface in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Is notified as transactions enter and exit.</div> +</dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionPair</span></a> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Pairs two transaction together into one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#TransactionPair(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">TransactionPair(Transaction, Transaction)</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionScope</span></a><<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="type parameter in TransactionScope">Txn</a>> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Container of thread local, scoped transactions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#transform(S)">transform(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> +<div class="block">This method must be implemented to transform storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#transform(S)">transform(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> +<div class="block">This method must be implemented to transform storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">TransformedCursor</span></a><<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a>,<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#TransformedCursor(com.amazon.carbonado.Cursor)">TransformedCursor(Cursor<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoFetchException(java.lang.Throwable)">transformIntoFetchException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoPersistException(java.lang.Throwable)">transformIntoPersistException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoRepositoryException(java.lang.Throwable)">transformIntoRepositoryException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><<a href="../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a>> - Class in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#Trigger()">Trigger()</a></span> - Constructor for class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Trigger.Abort</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">TriggerFactory</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Can be used with <a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a> to automatically register + triggers as Storable types become available.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></dt> +<dd> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">TriggerManager</span></a><<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager()">TriggerManager()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager(Class<S>, Iterable<TriggerFactory>)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">TriggerManagerCapability</span></a> - Interface in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Provides the capability to get the <a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">TriggerSupport</span></a><<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TrueFalseAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TrueFalseAdapter)">TrueFalseAdapter.Adapter(Class<?>, String, TrueFalseAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, boolean)">TrueFalseAdapter.Adapter(Class<?>, String, boolean)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#truncate()">truncate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Attempts to quickly delete all Storables instances in this + Storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_DELETE_METHOD_NAME">TRY_DELETE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_INSERT_METHOD_NAME">TRY_INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_METHOD_NAME">TRY_LOAD_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_ONE_METHOD_NAME">TRY_LOAD_ONE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_UPDATE_METHOD_NAME">TRY_UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryDelete(S, byte[])">tryDelete(S, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to delete the entry referenced by the given key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or one matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or one matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryInsert(S, byte[], byte[])">tryInsert(S, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to insert the entry referenced by the given key with the given + value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Inserts a new persistent value for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryLoad(S, byte[])">tryLoad(S, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to load the entry referenced by the given key, but return null + if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </div> +<!-- ======= 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-19.html">Prev Letter</a></li> +<li><a href="index-21.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-20.html" target="_top">Frames</a></li> +<li><a href="index-20.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> +<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> |