mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 00:39:34 +01:00
353 lines
19 KiB
HTML
353 lines
19 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>ThrowawayTransaction (Plan 5.2-SNAPSHOT API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
|
|
<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>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="ThrowawayTransaction (Plan 5.2-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10};
|
|
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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../../allclasses.html">All 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>
|
|
</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>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.djrapitops.plan.storage.database.transactions</a></div>
|
|
<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>
|
|
<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="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/storage/transactions/results/StorePlayerTableResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StorePlayerTableResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/StorePluginTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions">StorePluginTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/providers/StoreProviderTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.providers">StoreProviderTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StoreServerBooleanResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StoreServerBooleanResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StoreServerDoubleResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StoreServerDoubleResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StoreServerNumberResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StoreServerNumberResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StoreServerStringResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StoreServerStringResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/results/StoreServerTableResultTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.results">StoreServerTableResultTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/StoreTabInformationTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions">StoreTabInformationTransaction</a></code>, <code><a href="../../../extension/implementation/storage/transactions/providers/StoreTableProviderTransaction.html" title="class in com.djrapitops.plan.extension.implementation.storage.transactions.providers">StoreTableProviderTransaction</a></code></dd>
|
|
</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.
|
|
<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">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="fields.inherited.from.class.com.djrapitops.plan.storage.database.transactions.Transaction">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class 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>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</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"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</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">
|
|
<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">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class 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>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a id="<init>()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>ThrowawayTransaction</h4>
|
|
<pre>public ThrowawayTransaction()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<section role="region">
|
|
<ul class="blockList">
|
|
<li class="blockList"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a id="shouldBeExecuted()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>shouldBeExecuted</h4>
|
|
<pre class="methodSignature">protected boolean shouldBeExecuted()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Transaction.html#shouldBeExecuted()">Transaction</a></code></span></div>
|
|
<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> in class <code><a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>false if the transaction should not execute.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../../allclasses.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>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|