PSForever/PSF-LoginServer
1
0
Fork 0
mirror of https://github.com/psforever/PSF-LoginServer.git synced 2026-02-13 11:43:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
PSF-LoginServer/net/psforever/objects/guid/source/index.html

15 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.objects.guid.source</title><meta content="PSF - LoginServer - master - net.psforever.objects.guid.source" name="description"/><meta content="PSF LoginServer master net.psforever.objects.guid.source" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../../lib/index.js"></script><script type="text/javascript" src="../../../../../index.js"></script><script type="text/javascript" src="../../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.objects" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="objects"></a><a id="objects:objects"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">objects</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.objects.guid" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="guid"></a><a id="guid:guid"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">guid</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.guid.key" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="key"></a><a id="key:key"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/key/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../key/index.html" title=""><span class="name">key</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.guid.pool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="pool"></a><a id="pool:pool"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/pool/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../pool/index.html" title=""><span class="name">pool</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></dd></dl></div></li><li class="indented5 " name="net.psforever.objects.guid.selector" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="selector"></a><a id="selector:selector"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/selector/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../selector/index.html" title=""><span class="name">selector</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></dd></dl></div></li><li class="indented5 current" name="net.psforever.objects.guid.source" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="source"></a><a id="source:source"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">source</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></dd></dl></div></li><li class="current-entities indented5"><a href="MaxNumberSource$.html" title="" class="object"></a> <a href="MaxNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn." class="class"></a><a href="MaxNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn.">MaxNumberSource</a></li><li class="current-entities indented5"><span class="separator"></span> <a href="NumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn." class="trait"></a><a href="NumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn.">NumberSource</a></li><li class="current-entities indented5"><a href="SpecificNumberSource$.html" title="" class="object"></a> <a href="SpecificNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn." class="class"></a><a href="SpecificNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn.">SpecificNumberSource</a></li><li class="indented5 " name="net.psforever.objects.guid.uns" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="uns"></a><a id="uns:uns"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/uns/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../uns/index.html" title=""><span class="name">uns</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></dd></dl></div></li></ul></div></div><div id="content"><body class="package value"><div id="definition"><div class="big-circle package">p</div><p id="owner"><a href="../../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../../index.html" name="net.psforever.objects" id="net.psforever.objects" class="extype">objects</a>.<a href="../index.html" name="net.psforever.objects.guid" id="net.psforever.objects.guid" class="extype">guid</a></p><h1>source<span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/index.html" title="Permalink"><i class="material-icons"></i></a></span></h1></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><span class="name">source</span></span></h4><div id="comment" class="fullcommenttop"></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="types" class="types members"><h3>Type Members</h3><ol><li class="indented0 " name="net.psforever.objects.guid.source.MaxNumberSource" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="MaxNumberSourceextendsNumberSource"></a><a id="MaxNumberSource:MaxNumberSource"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/MaxNumberSource.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="MaxNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn."><span class="name">MaxNumberSource</span></a><span class="result"> extends <a href="NumberSource.html" name="net.psforever.objects.guid.source.NumberSource" id="net.psforever.objects.guid.source.NumberSource" class="extype">NumberSource</a></span></span><p class="shortcomment cmt">A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.</p><div class="fullcomment"><div class="comment cmt"><p>A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.
Produce a series of numbers from 0 to a maximum number (inclusive) to be used as globally unique identifiers (GUID's).</p></div><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="IllegalArgumentException" class="extype"><code>IllegalArgumentException</code></span> if <code>max</code> is less than zero (therefore the count of generated numbers is at most zero)</p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.source.NumberSource" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="NumberSourceextendsAnyRef"></a><a id="NumberSource:NumberSource"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/NumberSource.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="NumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn."><span class="name">NumberSource</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><p class="shortcomment cmt">A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.</p><div class="fullcomment"><div class="comment cmt"><p>A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.
The numbers are considered to be exclusive.<br>
<br>
The following are guidelines for implementing classes.
The numbers allocated to this source are from zero up through positive integers.
When a number is drawn from the pool, it is flagged internally and can not be selected for drawing again until the flag is removed.
Some flagging states are allowed to restrict that number for the whole lifespan of the source.
This internal flagging is maintained by a "monitor" that should not directly get exposed.
Use the provided indirect referencing containers - <code>SecureKey</code> and <code>LoanedKey</code>.<br>
<br>
The purpose of a <code>NumberSource</code> is to help facilitate globally unique identifiers (GUID, pl. GUIDs).
</p></div></div></li><li class="indented0 " name="net.psforever.objects.guid.source.SpecificNumberSource" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SpecificNumberSourceextendsNumberSource"></a><a id="SpecificNumberSource:SpecificNumberSource"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/SpecificNumberSource.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><a href="SpecificNumberSource.html" title="A NumberSource is considered a master &quot;pool&quot; of numbers from which all numbers are available to be drawn."><span class="name">SpecificNumberSource</span></a><span class="result"> extends <a href="NumberSource.html" name="net.psforever.objects.guid.source.NumberSource" id="net.psforever.objects.guid.source.NumberSource" class="extype">NumberSource</a></span></span><p class="shortcomment cmt">A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.</p><div class="fullcomment"><div class="comment cmt"><p>A <code>NumberSource</code> is considered a master "pool" of numbers from which all numbers are available to be drawn.
Produce a series of numbers from 0 to a maximum number (inclusive) to be used as globally unique identifiers (GUID's).</p></div><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="IllegalArgumentException" class="extype"><code>IllegalArgumentException</code></span> if any of the numbers provided are negative</p></span></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.guid.source.MaxNumberSource" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MaxNumberSource"></a><a id="MaxNumberSource:MaxNumberSource"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/MaxNumberSource$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="MaxNumberSource$.html" title=""><span class="name">MaxNumberSource</span></a></span></li><li class="indented0 " name="net.psforever.objects.guid.source.SpecificNumberSource" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SpecificNumberSource"></a><a id="SpecificNumberSource:SpecificNumberSource"></a> <span class="permalink"><a href="../../../../../net/psforever/objects/guid/source/SpecificNumberSource$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="SpecificNumberSource$.html" title=""><span class="name">SpecificNumberSource</span></a></span></li></ol></div></div><div id="inheritedMembers"></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink