Skip to content

Commit a5cb6a8

Browse files
committed
Deploy javadoc for 5.3.0-pre.1
1 parent 9ed7dcf commit a5cb6a8

File tree

9 files changed

+314
-138
lines changed

9 files changed

+314
-138
lines changed

javadoc/5.3.0-SNAPSHOT/allclasses-index.html

Lines changed: 68 additions & 64 deletions
Large diffs are not rendered by default.

javadoc/5.3.0-SNAPSHOT/index-all.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1397,8 +1397,10 @@ <h2 class="title" id="I:I">I</h2>
13971397
<dd>
13981398
<div class="block">Checks if a given ItemStack is a filler item created by this helper.</div>
13991399
</dd>
1400-
<dt><a href="org/mvplugins/multiverse/inventories/share/Sharables.html#isIgnoringSpawnListener(org.bukkit.entity.Player)" class="member-name-link">isIgnoringSpawnListener(Player)</a> - Static method in class org.mvplugins.multiverse.inventories.share.<a href="org/mvplugins/multiverse/inventories/share/Sharables.html" title="class in org.mvplugins.multiverse.inventories.share">Sharables</a></dt>
1401-
<dd>&nbsp;</dd>
1400+
<dt><a href="org/mvplugins/multiverse/inventories/handleshare/PlayerShareHandlingState.html#isHandlingSharable(org.bukkit.entity.Player,org.mvplugins.multiverse.inventories.share.Sharable)" class="member-name-link">isHandlingSharable(Player, Sharable&lt;?&gt;)</a> - Method in class org.mvplugins.multiverse.inventories.handleshare.<a href="org/mvplugins/multiverse/inventories/handleshare/PlayerShareHandlingState.html" title="class in org.mvplugins.multiverse.inventories.handleshare">PlayerShareHandlingState</a></dt>
1401+
<dd>
1402+
<div class="block">Checks if the given player is currently having the given sharable handled.</div>
1403+
</dd>
14021404
<dt><a href="org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditAction.html#isOnlinePlayerAffected(K,org.bukkit.entity.Player)" class="member-name-link">isOnlinePlayerAffected(K, Player)</a> - Method in class org.mvplugins.multiverse.inventories.profile.bulkedit.<a href="org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditAction.html" title="class in org.mvplugins.multiverse.inventories.profile.bulkedit">BulkEditAction</a></dt>
14031405
<dd>&nbsp;</dd>
14041406
<dt><a href="org/mvplugins/multiverse/inventories/share/Sharable.html#isOptional()" class="member-name-link">isOptional()</a> - Method in interface org.mvplugins.multiverse.inventories.share.<a href="org/mvplugins/multiverse/inventories/share/Sharable.html" title="interface in org.mvplugins.multiverse.inventories.share">Sharable</a></dt>
@@ -1934,6 +1936,10 @@ <h2 class="title" id="I:P">P</h2>
19341936
<dd>
19351937
<div class="block">Creates an instance of a <code>PlayerProfilesPayload</code> record class.</div>
19361938
</dd>
1939+
<dt><a href="org/mvplugins/multiverse/inventories/handleshare/PlayerShareHandlingState.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">PlayerShareHandlingState</a> - Class in <a href="org/mvplugins/multiverse/inventories/handleshare/package-summary.html">org.mvplugins.multiverse.inventories.handleshare</a></dt>
1940+
<dd>
1941+
<div class="block">Keeps track of players who are currently having their sharable handling processed.</div>
1942+
</dd>
19371943
<dt><a href="org/mvplugins/multiverse/inventories/util/PlayerStats.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.util">PlayerStats</a> - Class in <a href="org/mvplugins/multiverse/inventories/util/package-summary.html">org.mvplugins.multiverse.inventories.util</a></dt>
19381944
<dd>
19391945
<div class="block">A collection of values relating to a Minecraft player.</div>

javadoc/5.3.0-SNAPSHOT/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (21) -->
5+
<title>PlayerShareHandlingState (multiverse-inventories 5.3.0-SNAPSHOT API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8+
<meta name="description" content="declaration: package: org.mvplugins.multiverse.inventories.handleshare, class: PlayerShareHandlingState">
9+
<meta name="generator" content="javadoc/ClassWriterImpl">
10+
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
12+
<script type="text/javascript" src="../../../../../script.js"></script>
13+
<script type="text/javascript" src="../../../../../script-dir/jquery-3.7.1.min.js"></script>
14+
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
15+
</head>
16+
<body class="class-declaration-page">
17+
<script type="text/javascript">var pathtoroot = "../../../../../";
18+
loadScripts(document, 'script');</script>
19+
<noscript>
20+
<div>JavaScript is disabled on your browser.</div>
21+
</noscript>
22+
<div class="flex-box">
23+
<header role="banner" class="flex-header">
24+
<nav role="navigation">
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
27+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
28+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
29+
<li><a href="../../../../../index.html">Overview</a></li>
30+
<li><a href="package-summary.html">Package</a></li>
31+
<li class="nav-bar-cell1-rev">Class</li>
32+
<li><a href="package-tree.html">Tree</a></li>
33+
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
34+
<li><a href="../../../../../index-all.html">Index</a></li>
35+
<li><a href="../../../../../help-doc.html#class">Help</a></li>
36+
</ul>
37+
<ul class="sub-nav-list-small">
38+
<li>
39+
<p>Summary:</p>
40+
<ul>
41+
<li>Nested</li>
42+
<li>Field</li>
43+
<li>Constr</li>
44+
<li><a href="#method-summary">Method</a></li>
45+
</ul>
46+
</li>
47+
<li>
48+
<p>Detail:</p>
49+
<ul>
50+
<li>Field</li>
51+
<li>Constr</li>
52+
<li><a href="#method-detail">Method</a></li>
53+
</ul>
54+
</li>
55+
</ul>
56+
</div>
57+
<div class="sub-nav">
58+
<div id="navbar-sub-list">
59+
<ul class="sub-nav-list">
60+
<li>Summary:&nbsp;</li>
61+
<li>Nested&nbsp;|&nbsp;</li>
62+
<li>Field&nbsp;|&nbsp;</li>
63+
<li>Constr&nbsp;|&nbsp;</li>
64+
<li><a href="#method-summary">Method</a></li>
65+
</ul>
66+
<ul class="sub-nav-list">
67+
<li>Detail:&nbsp;</li>
68+
<li>Field&nbsp;|&nbsp;</li>
69+
<li>Constr&nbsp;|&nbsp;</li>
70+
<li><a href="#method-detail">Method</a></li>
71+
</ul>
72+
</div>
73+
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
74+
<input type="text" id="search-input" disabled placeholder="Search">
75+
<input type="reset" id="reset-button" disabled value="reset">
76+
</div>
77+
</div>
78+
<!-- ========= END OF TOP NAVBAR ========= -->
79+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
80+
</header>
81+
<div class="flex-content">
82+
<main role="main">
83+
<!-- ======== START OF CLASS DATA ======== -->
84+
<div class="header">
85+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.mvplugins.multiverse.inventories.handleshare</a></div>
86+
<h1 title="Class PlayerShareHandlingState" class="title">Class PlayerShareHandlingState</h1>
87+
</div>
88+
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
89+
<div class="inheritance">org.mvplugins.multiverse.inventories.handleshare.PlayerShareHandlingState</div>
90+
</div>
91+
<section class="class-description" id="class-description">
92+
<hr>
93+
<div class="type-signature"><span class="annotations">@AvailableSince("5.3")
94+
@Service
95+
</span><span class="modifiers">public final class </span><span class="element-name type-name-label">PlayerShareHandlingState</span>
96+
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
97+
<div class="block">Keeps track of players who are currently having their sharable handling processed.
98+
<br/>
99+
This is used to prevent infinite loops when updating sharables that may trigger events themselves or
100+
when suppressing notifications during the handling process.</div>
101+
<dl class="notes">
102+
<dt>Since:</dt>
103+
<dd>5.3</dd>
104+
</dl>
105+
</section>
106+
<section class="summary">
107+
<ul class="summary-list">
108+
<!-- ========== METHOD SUMMARY =========== -->
109+
<li>
110+
<section class="method-summary" id="method-summary">
111+
<h2>Method Summary</h2>
112+
<div id="method-summary-table">
113+
<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>
114+
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
115+
<div class="summary-table three-column-summary">
116+
<div class="table-header col-first">Modifier and Type</div>
117+
<div class="table-header col-second">Method</div>
118+
<div class="table-header col-last">Description</div>
119+
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
120+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isHandlingSharable(org.bukkit.entity.Player,org.mvplugins.multiverse.inventories.share.Sharable)" class="member-name-link">isHandlingSharable</a><wbr>(org.bukkit.entity.Player&nbsp;player,
121+
<a href="../share/Sharable.html" title="interface in org.mvplugins.multiverse.inventories.share">Sharable</a>&lt;?&gt;&nbsp;sharable)</code></div>
122+
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
123+
<div class="block">Checks if the given player is currently having the given sharable handled.</div>
124+
</div>
125+
</div>
126+
</div>
127+
</div>
128+
<div class="inherited-list">
129+
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
130+
<code><a href="https://docs.oracle.com/en/java/javase/21/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/21/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/21/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/21/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/21/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/21/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/21/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/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/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/21/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/21/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>
131+
</section>
132+
</li>
133+
</ul>
134+
</section>
135+
<section class="details">
136+
<ul class="details-list">
137+
<!-- ============ METHOD DETAIL ========== -->
138+
<li>
139+
<section class="method-details" id="method-detail">
140+
<h2>Method Details</h2>
141+
<ul class="member-list">
142+
<li>
143+
<section class="detail" id="isHandlingSharable(org.bukkit.entity.Player,org.mvplugins.multiverse.inventories.share.Sharable)">
144+
<h3>isHandlingSharable</h3>
145+
<div class="member-signature"><span class="annotations">@AvailableSince("5.3")
146+
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isHandlingSharable</span><wbr><span class="parameters">(org.bukkit.entity.Player&nbsp;player,
147+
<a href="../share/Sharable.html" title="interface in org.mvplugins.multiverse.inventories.share">Sharable</a>&lt;?&gt;&nbsp;sharable)</span></div>
148+
<div class="block">Checks if the given player is currently having the given sharable handled.</div>
149+
<dl class="notes">
150+
<dt>Parameters:</dt>
151+
<dd><code>player</code> - The player to check.</dd>
152+
<dd><code>sharable</code> - The sharable to check.</dd>
153+
<dt>Returns:</dt>
154+
<dd>True if the player is having the sharable handled, false otherwise.</dd>
155+
<dt>Since:</dt>
156+
<dd>5.3</dd>
157+
</dl>
158+
</section>
159+
</li>
160+
</ul>
161+
</section>
162+
</li>
163+
</ul>
164+
</section>
165+
<!-- ========= END OF CLASS DATA ========= -->
166+
</main>
167+
</div>
168+
</div>
169+
</body>
170+
</html>

javadoc/5.3.0-SNAPSHOT/org/mvplugins/multiverse/inventories/handleshare/package-summary.html

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -100,22 +100,26 @@ <h1 title="Package org.mvplugins.multiverse.inventories.handleshare" class="titl
100100
<div class="col-last even-row-color class-summary class-summary-tab2">
101101
<div class="block">Simple class for groups that are going to be saved/loaded.</div>
102102
</div>
103-
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReadOnlyShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">ReadOnlyShareHandler</a></div>
104-
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
105-
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ShareHandlingUpdater.html" title="class in org.mvplugins.multiverse.inventories.handleshare">ShareHandlingUpdater</a></div>
103+
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PlayerShareHandlingState.html" title="class in org.mvplugins.multiverse.inventories.handleshare">PlayerShareHandlingState</a></div>
104+
<div class="col-last odd-row-color class-summary class-summary-tab2">
105+
<div class="block">Keeps track of players who are currently having their sharable handling processed.</div>
106+
</div>
107+
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReadOnlyShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">ReadOnlyShareHandler</a></div>
106108
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
107-
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SingleShareReader.html" title="class in org.mvplugins.multiverse.inventories.handleshare">SingleShareReader</a>&lt;T&gt;</div>
109+
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ShareHandlingUpdater.html" title="class in org.mvplugins.multiverse.inventories.handleshare">ShareHandlingUpdater</a></div>
108110
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
109-
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SingleShareWriter.html" title="class in org.mvplugins.multiverse.inventories.handleshare">SingleShareWriter</a>&lt;T&gt;</div>
110-
<div class="col-last even-row-color class-summary class-summary-tab2">
111+
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SingleShareReader.html" title="class in org.mvplugins.multiverse.inventories.handleshare">SingleShareReader</a>&lt;T&gt;</div>
112+
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
113+
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SingleShareWriter.html" title="class in org.mvplugins.multiverse.inventories.handleshare">SingleShareWriter</a>&lt;T&gt;</div>
114+
<div class="col-last odd-row-color class-summary class-summary-tab2">
111115
<div class="block">Write a single share to the relevant world and group profiles.</div>
112116
</div>
113-
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WorldChangeShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">WorldChangeShareHandler</a></div>
114-
<div class="col-last odd-row-color class-summary class-summary-tab2">
117+
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="WorldChangeShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">WorldChangeShareHandler</a></div>
118+
<div class="col-last even-row-color class-summary class-summary-tab2">
115119
<div class="block">WorldChange implementation of ShareHandler.</div>
116120
</div>
117-
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="WriteOnlyShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">WriteOnlyShareHandler</a></div>
118-
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
121+
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WriteOnlyShareHandler.html" title="class in org.mvplugins.multiverse.inventories.handleshare">WriteOnlyShareHandler</a></div>
122+
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
119123
</div>
120124
</div>
121125
</li>

javadoc/5.3.0-SNAPSHOT/org/mvplugins/multiverse/inventories/handleshare/package-tree.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
6262
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="AffectedProfiles.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">AffectedProfiles</a></li>
6363
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="GameModeShareHandler.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">GameModeShareHandler</a></li>
6464
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="PersistingProfile.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">PersistingProfile</a></li>
65+
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="PlayerShareHandlingState.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">PlayerShareHandlingState</a></li>
6566
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="ReadOnlyShareHandler.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">ReadOnlyShareHandler</a></li>
6667
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="ShareHandlingUpdater.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">ShareHandlingUpdater</a></li>
6768
<li class="circle">org.mvplugins.multiverse.inventories.handleshare.<a href="SingleShareReader.html" class="type-name-link" title="class in org.mvplugins.multiverse.inventories.handleshare">SingleShareReader</a>&lt;T&gt;</li>

0 commit comments

Comments
 (0)