mirror of
https://github.com/AtlasMediaGroup/Scissors-Website.git
synced 2024-09-06 07:48:13 +00:00
353 lines
25 KiB
HTML
353 lines
25 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (17) -->
|
||
|
<title>BanEntry (Scissors-API 1.18.2-R0.1-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: org.bukkit, interface: BanEntry">
|
||
|
<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>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method-summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="sub-nav-list">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </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">org.bukkit</a></div>
|
||
|
<h1 title="Interface BanEntry" class="title">Interface BanEntry</h1>
|
||
|
</div>
|
||
|
<section class="class-description" id="class-description">
|
||
|
<hr>
|
||
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">BanEntry</span></div>
|
||
|
<div class="block">A single entry from a ban list. This may represent either a player ban or
|
||
|
an IP ban.
|
||
|
<p>
|
||
|
Ban entries include the following properties:
|
||
|
<table border=1>
|
||
|
<caption>Property information</caption>
|
||
|
<tr>
|
||
|
<th>Property</th>
|
||
|
<th>Description</th>
|
||
|
</tr><tr>
|
||
|
<td>Target Name / IP Address</td>
|
||
|
<td>The target name or IP address</td>
|
||
|
</tr><tr>
|
||
|
<td>Creation Date</td>
|
||
|
<td>The creation date of the ban</td>
|
||
|
</tr><tr>
|
||
|
<td>Source</td>
|
||
|
<td>The source of the ban, such as a player, console, plugin, etc</td>
|
||
|
</tr><tr>
|
||
|
<td>Expiration Date</td>
|
||
|
<td>The expiration date of the ban</td>
|
||
|
</tr><tr>
|
||
|
<td>Reason</td>
|
||
|
<td>The reason for the ban</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<p>
|
||
|
Unsaved information is not automatically written to the implementation's
|
||
|
ban list, instead, the <a href="#save()"><code>save()</code></a> method must be called to write the
|
||
|
changes to the ban list. If this ban entry has expired (such as from an
|
||
|
unban) and is no longer found in the list, the <a href="#save()"><code>save()</code></a> call will
|
||
|
re-add it to the list, therefore banning the victim specified.
|
||
|
<p>
|
||
|
Likewise, changes to the associated <a href="BanList.html" title="interface in org.bukkit"><code>BanList</code></a> or other entries may or
|
||
|
may not be reflected in this entry.</div>
|
||
|
</section>
|
||
|
<section class="summary">
|
||
|
<ul class="summary-list">
|
||
|
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCreated()" class="member-name-link">getCreated</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the date this ban entry was created.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a></code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getExpiration()" class="member-name-link">getExpiration</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the date this ban expires on, or null for no defined end date.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getReason()" class="member-name-link">getReason</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the reason for this ban.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSource()" class="member-name-link">getSource</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the source of this ban.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTarget()" class="member-name-link">getTarget</a>()</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Gets the target involved.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#save()" class="member-name-link">save</a>()</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Saves the ban entry, overwriting any previous data in the ban list.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCreated(java.util.Date)" class="member-name-link">setCreated</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> created)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Sets the date this ban entry was created.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setExpiration(java.util.Date)" class="member-name-link">setExpiration</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> expiration)</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Sets the date this ban expires on.</div>
|
||
|
</div>
|
||
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
||
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setReason(java.lang.String)" class="member-name-link">setReason</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> reason)</code></div>
|
||
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Sets the reason for this ban.</div>
|
||
|
</div>
|
||
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
||
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setSource(java.lang.String)" class="member-name-link">setSource</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> source)</code></div>
|
||
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||
|
<div class="block">Sets the source of this ban.</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<section class="details">
|
||
|
<ul class="details-list">
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<li>
|
||
|
<section class="method-details" id="method-detail">
|
||
|
<h2>Method Details</h2>
|
||
|
<ul class="member-list">
|
||
|
<li>
|
||
|
<section class="detail" id="getTarget()">
|
||
|
<h3>getTarget</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTarget</span>()</div>
|
||
|
<div class="block">Gets the target involved. This may be in the form of an IP or a player
|
||
|
name.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>the target name or IP address</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getCreated()">
|
||
|
<h3>getCreated</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a></span> <span class="element-name">getCreated</span>()</div>
|
||
|
<div class="block">Gets the date this ban entry was created.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>the creation date</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="setCreated(java.util.Date)">
|
||
|
<h3>setCreated</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setCreated</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> created)</span></div>
|
||
|
<div class="block">Sets the date this ban entry was created.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>created</code> - the new created date, cannot be null</dd>
|
||
|
<dt>See Also:</dt>
|
||
|
<dd>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="#save()"><code>saving changes</code></a></li>
|
||
|
</ul>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getSource()">
|
||
|
<h3>getSource</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSource</span>()</div>
|
||
|
<div class="block">Gets the source of this ban.
|
||
|
<p>
|
||
|
Note: A source is considered any String, although this is generally a
|
||
|
player name.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>the source of the ban</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="setSource(java.lang.String)">
|
||
|
<h3>setSource</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setSource</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> source)</span></div>
|
||
|
<div class="block">Sets the source of this ban.
|
||
|
<p>
|
||
|
Note: A source is considered any String, although this is generally a
|
||
|
player name.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>source</code> - the new source where null values become empty strings</dd>
|
||
|
<dt>See Also:</dt>
|
||
|
<dd>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="#save()"><code>saving changes</code></a></li>
|
||
|
</ul>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getExpiration()">
|
||
|
<h3>getExpiration</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a></span> <span class="element-name">getExpiration</span>()</div>
|
||
|
<div class="block">Gets the date this ban expires on, or null for no defined end date.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>the expiration date</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="setExpiration(java.util.Date)">
|
||
|
<h3>setExpiration</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setExpiration</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> expiration)</span></div>
|
||
|
<div class="block">Sets the date this ban expires on. Null values are considered
|
||
|
"infinite" bans.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>expiration</code> - the new expiration date, or null to indicate an
|
||
|
eternity</dd>
|
||
|
<dt>See Also:</dt>
|
||
|
<dd>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="#save()"><code>saving changes</code></a></li>
|
||
|
</ul>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="getReason()">
|
||
|
<h3>getReason</h3>
|
||
|
<div class="member-signature"><span class="annotations"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
</span><span class="return-type"><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getReason</span>()</div>
|
||
|
<div class="block">Gets the reason for this ban.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Returns:</dt>
|
||
|
<dd>the ban reason, or null if not set</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="setReason(java.lang.String)">
|
||
|
<h3>setReason</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">setReason</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a>
|
||
|
<a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> reason)</span></div>
|
||
|
<div class="block">Sets the reason for this ban. Reasons must not be null.</div>
|
||
|
<dl class="notes">
|
||
|
<dt>Parameters:</dt>
|
||
|
<dd><code>reason</code> - the new reason, null values assume the implementation
|
||
|
default</dd>
|
||
|
<dt>See Also:</dt>
|
||
|
<dd>
|
||
|
<ul class="see-list">
|
||
|
<li><a href="#save()"><code>saving changes</code></a></li>
|
||
|
</ul>
|
||
|
</dd>
|
||
|
</dl>
|
||
|
</section>
|
||
|
</li>
|
||
|
<li>
|
||
|
<section class="detail" id="save()">
|
||
|
<h3>save</h3>
|
||
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">save</span>()</div>
|
||
|
<div class="block">Saves the ban entry, overwriting any previous data in the ban list.
|
||
|
<p>
|
||
|
Saving the ban entry of an unbanned player will cause the player to be
|
||
|
banned once again.</div>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</section>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
</main>
|
||
|
</div>
|
||
|
</div>
|
||
|
</body>
|
||
|
</html>
|