diff options
Diffstat (limited to 'javadoc/net/minecraftforge/common/UsernameCache.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/UsernameCache.html | 339 |
1 files changed, 0 insertions, 339 deletions
diff --git a/javadoc/net/minecraftforge/common/UsernameCache.html b/javadoc/net/minecraftforge/common/UsernameCache.html deleted file mode 100644 index 055d13a..0000000 --- a/javadoc/net/minecraftforge/common/UsernameCache.html +++ /dev/null @@ -1,339 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:17 EST 2015 --> -<title>UsernameCache (Forge API)</title> -<meta name="date" content="2015-02-05"> -<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="UsernameCache (Forge API)"; - } -//--> -</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-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../net/minecraftforge/common/MinecraftForge.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html" title="class in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?net/minecraftforge/common/UsernameCache.html" target="_top">Frames</a></li> -<li><a href="UsernameCache.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>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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">net.minecraftforge.common</div> -<h2 title="Class UsernameCache" class="title">Class UsernameCache</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>net.minecraftforge.common.UsernameCache</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public final class <span class="strong">UsernameCache</span> -extends java.lang.Object</pre> -<div class="block">Caches player's last known usernames - <p> - Modders should use <a href="../../../net/minecraftforge/common/UsernameCache.html#getLastKnownUsername(java.util.UUID)"><code>getLastKnownUsername(UUID)</code></a> to determine a players - last known username.<br> - For convenience, <a href="../../../net/minecraftforge/common/UsernameCache.html#getMap()"><code>getMap()</code></a> is provided to get an immutable copy of - the caches underlying map.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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 boolean</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#containsUUID(java.util.UUID)">containsUUID</a></strong>(java.util.UUID uuid)</code> -<div class="block">Check if the cache contains the given player's username</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#getLastKnownUsername(java.util.UUID)">getLastKnownUsername</a></strong>(java.util.UUID uuid)</code> -<div class="block">Get the player's last known username</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static java.util.Map<java.util.UUID,java.lang.String></code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#getMap()">getMap</a></strong>()</code> -<div class="block">Get an immutable copy of the cache's underlying map</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected static void</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#load()">load</a></strong>()</code> -<div class="block">Load the cache from file</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected static boolean</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#removeUsername(java.util.UUID)">removeUsername</a></strong>(java.util.UUID uuid)</code> -<div class="block">Remove a player's username from the cache</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected static void</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#save()">save</a></strong>()</code> -<div class="block">Save the cache to file</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected static void</code></td> -<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#setUsername(java.util.UUID,%20java.lang.String)">setUsername</a></strong>(java.util.UUID uuid, - java.lang.String username)</code> -<div class="block">Set a player's current username</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"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="setUsername(java.util.UUID, java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setUsername</h4> -<pre>protected static void setUsername(java.util.UUID uuid, - java.lang.String username)</pre> -<div class="block">Set a player's current username</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd><dd><code>username</code> - the player's username</dd></dl> -</li> -</ul> -<a name="removeUsername(java.util.UUID)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>removeUsername</h4> -<pre>protected static boolean removeUsername(java.util.UUID uuid)</pre> -<div class="block">Remove a player's username from the cache</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> -<dt><span class="strong">Returns:</span></dt><dd>if the cache contained the user</dd></dl> -</li> -</ul> -<a name="getLastKnownUsername(java.util.UUID)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getLastKnownUsername</h4> -<pre>@Nullable -public static java.lang.String getLastKnownUsername(java.util.UUID uuid)</pre> -<div class="block">Get the player's last known username - <p> - <b>May be <code>null</code></b></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> -<dt><span class="strong">Returns:</span></dt><dd>the player's last known username, or <code>null</code> if the - cache doesn't have a record of the last username</dd></dl> -</li> -</ul> -<a name="containsUUID(java.util.UUID)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>containsUUID</h4> -<pre>public static boolean containsUUID(java.util.UUID uuid)</pre> -<div class="block">Check if the cache contains the given player's username</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> -<dt><span class="strong">Returns:</span></dt><dd>if the cache contains a username for the given player</dd></dl> -</li> -</ul> -<a name="getMap()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMap</h4> -<pre>public static java.util.Map<java.util.UUID,java.lang.String> getMap()</pre> -<div class="block">Get an immutable copy of the cache's underlying map</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the map</dd></dl> -</li> -</ul> -<a name="save()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>save</h4> -<pre>protected static void save()</pre> -<div class="block">Save the cache to file</div> -</li> -</ul> -<a name="load()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>load</h4> -<pre>protected static void load()</pre> -<div class="block">Load the cache from file</div> -</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-all.html">Index</a></li> -<li><a href="../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../net/minecraftforge/common/MinecraftForge.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html" title="class in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?net/minecraftforge/common/UsernameCache.html" target="_top">Frames</a></li> -<li><a href="UsernameCache.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>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> |
