mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-02 00:39:34 +01:00
193 lines
20 KiB
HTML
193 lines
20 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>ThrowawayTransaction (Plan 5.5-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.djrapitops.plan.storage.database.transactions, class: ThrowawayTransaction">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<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="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.storage.database.transactions</a></div>
|
|
<h1 title="Class ThrowawayTransaction" class="title">Class ThrowawayTransaction</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance"><a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">com.djrapitops.plan.storage.database.transactions.Transaction</a>
|
|
<div class="inheritance">com.djrapitops.plan.storage.database.transactions.ThrowawayTransaction</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<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/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="../../../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/RemoveOldAccessLogTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.init">RemoveOldAccessLogTransaction</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="events/StoreNicknameTransaction.html" title="class in com.djrapitops.plan.storage.database.transactions.events">StoreNicknameTransaction</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>
|
|
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ThrowawayTransaction</span>
|
|
<span class="extends-implements">extends <a href="Transaction.html" title="class in com.djrapitops.plan.storage.database.transactions">Transaction</a></span></div>
|
|
<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>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="inherited-list">
|
|
<h3 id="fields-inherited-from-class-com.djrapitops.plan.storage.database.transactions.Transaction">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></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ThrowawayTransaction</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldBeExecuted()" class="member-name-link">shouldBeExecuted</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Override this method for conditional execution.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.djrapitops.plan.storage.database.transactions.Transaction">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#executeReturningId(com.djrapitops.plan.storage.database.transactions.ExecStatement)">executeReturningId</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#getName()">getName</a>, <a href="Transaction.html#getServerUUID()">getServerUUID</a>, <a href="Transaction.html#hasTable(java.lang.String)">hasTable</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></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>ThrowawayTransaction</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ThrowawayTransaction</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="shouldBeExecuted()">
|
|
<h3>shouldBeExecuted</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">shouldBeExecuted</span>()</div>
|
|
<div class="block"><span class="descfrm-type-label">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 class="notes">
|
|
<dt>Overrides:</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>Returns:</dt>
|
|
<dd>false if the transaction should not execute.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|