Plan/all/com/djrapitops/plan/storage/database/transactions/ThrowawayTransaction.html

353 lines
19 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2019-10-05 10:27:37 +02:00
<!-- NewPage -->
<html lang="en">
2019-10-05 10:27:37 +02:00
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
<title>ThrowawayTransaction (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2019-10-05 10:27:37 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
2019-10-05 10:27:37 +02:00
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
2019-10-05 10:27:37 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ThrowawayTransaction (Plan 5.2-SNAPSHOT API)";
2019-10-05 10:27:37 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":10};
2019-10-05 10:27:37 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2019-10-05 10:27:37 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2019-10-05 10:27:37 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
2019-10-05 10:27:37 +02:00
<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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2019-10-05 10:27:37 +02:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-10-05 10:27:37 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
2019-10-05 10:27:37 +02:00
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2019-10-05 10:27:37 +02:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2019-10-05 10:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2019-10-05 10:27:37 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.storage.database.transactions</a></div>
2019-10-05 10:27:37 +02:00
<h2 title="Class ThrowawayTransaction" class="title">Class ThrowawayTransaction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">com.djrapitops.plan.storage.database.transactions.Transaction</a></li>
2019-10-05 10:27:37 +02:00
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.storage.database.transactions.ThrowawayTransaction</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="events/KickStoreTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.events">KickStoreTransaction</a></code>, <code><a href="events/NicknameStoreTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.events">NicknameStoreTransaction</a></code>, <code><a href="events/OperatorStatusTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.events">OperatorStatusTransaction</a></code>, <code><a href="init/RemoveDuplicateUserInfoTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.init">RemoveDuplicateUserInfoTransaction</a></code>, <code><a href="commands/RemoveEverythingTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.commands">RemoveEverythingTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/RemoveInvalidResultsTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">RemoveInvalidResultsTransaction</a></code>, <code><a href="init/RemoveOldExtensionsTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.init">RemoveOldExtensionsTransaction</a></code>, <code><a href="init/RemoveOldSampledDataTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.init">RemoveOldSampledDataTransaction</a></code>, <code><a href="commands/RemovePlayerTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.commands">RemovePlayerTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalPlayerResultsTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">RemoveUnsatisfiedConditionalPlayerResultsTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/RemoveUnsatisfiedConditionalServerResultsTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">RemoveUnsatisfiedConditionalServerResultsTransaction</a></code>, <code><a href="events/ServerShutdownTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.events">ServerShutdownTransaction</a></code>, <code><a href="commands/SetServerAsUninstalledTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.commands">SetServerAsUninstalledTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/StoreIconTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions">StoreIconTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StorePlayerBooleanResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerBooleanResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StorePlayerDoubleResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerDoubleResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StorePlayerGroupsResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerGroupsResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StorePlayerNumberResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerNumberResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StorePlayerStringResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerStringResultTransaction</a></code>, <code><a href="../../../extension/implementation/s
2019-10-05 10:27:37 +02:00
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">ThrowawayTransaction</span>
extends <a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></pre>
<div class="block"><a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions"><code>Transaction</code></a> that can be thrown away if it is in execution when the database is closing.
2019-10-05 10:27:37 +02:00
<p>
This transaction type is for storing data that is not critical to be saved on plugin shutdown.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
2019-10-05 10:27:37 +02:00
<ul class="blockList">
<li class="blockList"><a id="field.summary">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.djrapitops.plan.storage.database.transactions.Transaction">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.djrapitops.plan.storage.database.transactions.<a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></h3>
<code><a href="Transaction.html#attempts">attempts</a>, <a href="Transaction.html#dbType">dbType</a>, <a href="Transaction.html#success">success</a></code></li>
2019-10-05 10:27:37 +02:00
</ul>
</li>
</ul>
</section>
2019-10-05 10:27:37 +02:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
2019-10-05 10:27:37 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
2019-10-05 10:27:37 +02:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
2019-10-05 10:27:37 +02:00
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ThrowawayTransaction</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2019-10-05 10:27:37 +02:00
</tr>
</table>
</li>
</ul>
</section>
2019-10-05 10:27:37 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2019-10-05 10:27:37 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
2019-10-05 10:27:37 +02:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2019-10-05 10:27:37 +02:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shouldBeExecuted()">shouldBeExecuted</a></span>()</code></th>
<td class="colLast">
2019-10-05 10:27:37 +02:00
<div class="block">Override this method for conditional execution.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.storage.database.transactions.Transaction">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.djrapitops.plan.storage.database.transactions.<a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></h3>
<code><a href="Transaction.html#dbIsNotUnderHeavyLoad()">dbIsNotUnderHeavyLoad</a>, <a href="Transaction.html#execute(com.djrapitops.plan.storage.database.transactions.Executable)">execute</a>, <a href="Transaction.html#execute(java.lang.String)">execute</a>, <a href="Transaction.html#executeOther(com.djrapitops.plan.storage.database.transactions.Transaction)">executeOther</a>, <a href="Transaction.html#executeSwallowingExceptions(java.lang.String...)">executeSwallowingExceptions</a>, <a href="Transaction.html#executeTransaction(com.djrapitops.plan.storage.database.SQLDB)">executeTransaction</a>, <a href="Transaction.html#getDBState()">getDBState</a>, <a href="Transaction.html#getServerUUID()">getServerUUID</a>, <a href="Transaction.html#performOperations()">performOperations</a>, <a href="Transaction.html#query(com.djrapitops.plan.storage.database.queries.Query)">query</a>, <a href="Transaction.html#toString()">toString</a>, <a href="Transaction.html#wasSuccessful()">wasSuccessful</a></code></li>
2019-10-05 10:27:37 +02:00
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2019-10-05 10:27:37 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
2019-10-05 10:27:37 +02:00
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ThrowawayTransaction</h4>
<pre>public&nbsp;ThrowawayTransaction()</pre>
</li>
</ul>
</li>
</ul>
</section>
2019-10-05 10:27:37 +02:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2019-10-05 10:27:37 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="shouldBeExecuted()">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shouldBeExecuted</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;shouldBeExecuted()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="Transaction.html#shouldBeExecuted()">Transaction</a></code></span></div>
2019-10-05 10:27:37 +02:00
<div class="block">Override this method for conditional execution.
<p>
Please note that the transaction has not been initialized and class variables are not available for
queries. The condition should depend on other variables (Like the data that is to be stored) given to the transaction.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="Transaction.html#shouldBeExecuted()">shouldBeExecuted</a></code>&nbsp;in class&nbsp;<code><a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></code></dd>
2019-10-05 10:27:37 +02:00
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false if the transaction should not execute.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
2019-10-05 10:27:37 +02:00
</li>
</ul>
</div>
</div>
</main>
2019-10-05 10:27:37 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2019-10-05 10:27:37 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2019-10-05 10:27:37 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
2019-10-05 10:27:37 +02:00
<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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
2019-10-05 10:27:37 +02:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2019-10-05 10:27:37 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
2019-10-05 10:27:37 +02:00
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2019-10-05 10:27:37 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2019-10-05 10:27:37 +02:00
</body>
</html>