mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-26 15:16:45 +01:00
446 lines
21 KiB
HTML
446 lines
21 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="sv">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:54 CET 2014 -->
|
|
<title>UUIDHandler</title>
|
|
<meta name="date" content="2014-11-16">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title = "UUIDHandler";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/intellectualcrafters/plot/util/StringComparison.html"
|
|
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/UUIDHandler.html"
|
|
target="_top">Frames</a></li>
|
|
<li><a href="UUIDHandler.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></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>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </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 name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">com.intellectualcrafters.plot.util</div>
|
|
<h2 title="Class UUIDHandler" class="title">Class UUIDHandler</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.intellectualcrafters.plot.util.UUIDHandler</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">UUIDHandler</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">This class can be used to efficiently translate UUIDs and names back and
|
|
forth.
|
|
It uses three primary methods of achieving this:
|
|
- Read From Cache
|
|
- Read from OfflinePlayer objects
|
|
- Read from (if onlinemode: mojang api) (else: playername hashing)
|
|
All UUIDs/Usernames will be stored in a map (cache) until the server is
|
|
restarted.
|
|
<p/>
|
|
You can use getUuidMap() to save the uuids/names to a file (SQLite db for
|
|
example).
|
|
Primary methods: getUUID(String name) & getName(UUID uuid) <-- You should
|
|
ONLY use these.
|
|
Call startFetch(JavaPlugin plugin) in your onEnable().
|
|
<p/>
|
|
Originally created by:
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
|
|
summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#UUIDHandler()">UUIDHandler</a></strong>()</code>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
|
|
summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#add(com.intellectualcrafters.plot.object.StringWrapper,%20java.util.UUID)">add</a></strong>(<a
|
|
href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a> name,
|
|
java.util.UUID uuid)</code>
|
|
|
|
<div class="block">Add a set to the cache</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#getName(java.util.UUID)">getName</a></strong>(java.util.UUID uuid)</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static java.util.UUID</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#getUUID(java.lang.String)">getUUID</a></strong>(java.lang.String name)</code>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static com.google.common.collect.BiMap<<a
|
|
href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a>,java.util.UUID>
|
|
</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#getUuidMap()">getUuidMap</a></strong>()</code>
|
|
|
|
<div class="block">Get the map containing all names/uuids</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#handleSaving()">handleSaving</a></strong>()</code>
|
|
|
|
<div class="block">Handle saving of uuids</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#nameExists(com.intellectualcrafters.plot.object.StringWrapper)">nameExists</a></strong>(<a
|
|
href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a> name)</code>
|
|
|
|
<div class="block">Check if a name is cached</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a
|
|
href="../../../../com/intellectualcrafters/plot/util/UUIDHandler.html#uuidExists(java.util.UUID)">uuidExists</a></strong>(java.util.UUID uuid)</code>
|
|
|
|
<div class="block">Check if a uuid is cached</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="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, toString, wait, wait,
|
|
wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
|
|
<h3>Constructor Detail</h3>
|
|
<a name="UUIDHandler()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>UUIDHandler</h4>
|
|
<pre>public UUIDHandler()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
|
|
<h3>Method Detail</h3>
|
|
<a name="getUuidMap()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUuidMap</h4>
|
|
<pre>public static com.google.common.collect.BiMap<<a
|
|
href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a>,java.util.UUID> getUuidMap()</pre>
|
|
<div class="block">Get the map containing all names/uuids</div>
|
|
<dl>
|
|
<dt><span class="strong">Returns:</span></dt>
|
|
<dd>map with names + uuids</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="uuidExists(java.util.UUID)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>uuidExists</h4>
|
|
<pre>public static boolean uuidExists(java.util.UUID uuid)</pre>
|
|
<div class="block">Check if a uuid is cached</div>
|
|
<dl>
|
|
<dt><span class="strong">Parameters:</span></dt>
|
|
<dd><code>uuid</code> - to check</dd>
|
|
<dt><span class="strong">Returns:</span></dt>
|
|
<dd>true of the uuid is cached</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="nameExists(com.intellectualcrafters.plot.object.StringWrapper)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>nameExists</h4>
|
|
<pre>public static boolean nameExists(<a
|
|
href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a> name)</pre>
|
|
<div class="block">Check if a name is cached</div>
|
|
<dl>
|
|
<dt><span class="strong">Parameters:</span></dt>
|
|
<dd><code>name</code> - to check</dd>
|
|
<dt><span class="strong">Returns:</span></dt>
|
|
<dd>true of the name is cached</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="add(com.intellectualcrafters.plot.object.StringWrapper, java.util.UUID)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>add</h4>
|
|
<pre>public static void add(<a href="../../../../com/intellectualcrafters/plot/object/StringWrapper.html"
|
|
title="class in com.intellectualcrafters.plot.object">StringWrapper</a> name,
|
|
java.util.UUID uuid)</pre>
|
|
<div class="block">Add a set to the cache</div>
|
|
<dl>
|
|
<dt><span class="strong">Parameters:</span></dt>
|
|
<dd><code>name</code> - to cache</dd>
|
|
<dd><code>uuid</code> - to cache</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getUUID(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUUID</h4>
|
|
<pre>public static java.util.UUID getUUID(java.lang.String name)</pre>
|
|
<dl>
|
|
<dt><span class="strong">Parameters:</span></dt>
|
|
<dd><code>name</code> - to use as key</dd>
|
|
<dt><span class="strong">Returns:</span></dt>
|
|
<dd>uuid</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getName(java.util.UUID)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre>public static java.lang.String getName(java.util.UUID uuid)</pre>
|
|
<dl>
|
|
<dt><span class="strong">Parameters:</span></dt>
|
|
<dd><code>uuid</code> - to use as key</dd>
|
|
<dt><span class="strong">Returns:</span></dt>
|
|
<dd>Name</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="handleSaving()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>handleSaving</h4>
|
|
<pre>public static void handleSaving()</pre>
|
|
<div class="block">Handle saving of uuids</div>
|
|
<dl>
|
|
<dt><span class="strong">See Also:</span></dt>
|
|
<dd>
|
|
<a href="../../../../com/intellectualcrafters/plot/uuid/UUIDSaver.html#globalSave(com.google.common.collect.BiMap)"><code>UUIDSaver.globalSave(com.google.common.collect.BiMap)</code></a>
|
|
</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../overview-summary.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../com/intellectualcrafters/plot/util/StringComparison.html"
|
|
title="class in com.intellectualcrafters.plot.util"><span class="strong">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/intellectualcrafters/plot/util/UUIDHandler.html"
|
|
target="_top">Frames</a></li>
|
|
<li><a href="UUIDHandler.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.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>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </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 name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|