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

70 lines
67 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.NumberPoolHub</title><meta content="PSF - LoginServer - master - net.psforever.objects.guid.NumberPoolHub" name="description"/><meta content="PSF LoginServer master net.psforever.objects.guid.NumberPoolHub" 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 " 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"><a href="source/index.html" title=""><span class="name">source</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.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><li class="current-entities indented4"><span class="separator"></span> <a href="GUIDTask$.html" title="The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers. Almost all of these functions will be invoked from WorldSessionActor." class="object"></a><a href="GUIDTask$.html" title="The basic compiled tasks for assigning (registering) and revoking (unregistering) globally unique identifiers. Almost all of these functions will be invoked from WorldSessionActor.">GUIDTask</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="" title="A master object that manages NumberPools when they are applied to a single NumberSource." class="class"></a><a href="" title="A master object that manages NumberPools when they are applied to a single NumberSource.">NumberPoolHub</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="RegisteredToWrongPlaceException.html" title="The entity was registered, but not to the target UNS." class="class"></a><a href="RegisteredToWrongPlaceException.html" title="The entity was registered, but not to the target UNS.">RegisteredToWrongPlaceException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="RegisteringException.html" title="" class="class"></a><a href="RegisteringException.html" title="">RegisteringException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="StraightforwardTask.html" title="A primary unit of work in a workflow that is set up to execute and never be taken back." class="trait"></a><a href="StraightforwardTask.html" title="A primary unit of work in a workflow that is set up to execute and never be taken back.">StraightforwardTask</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="Task.html" title="A primary unit of work in a workflow." class="trait"></a><a href="Task.html" title="A primary unit of work in a workflow.">Task</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskBehaviors.html" title="Parts of the task resolution lifecycle." class="trait"></a><a href="TaskBehaviors.html" title="Parts of the task resolution lifecycle.">TaskBehaviors</a></li><li class="current-entities indented4"><a href="TaskBundle$.html" title="" class="object"></a> <a href="TaskBundle.html" title="The packaging of a more complicated unit of work in a workflow in which one task relies on the successful completion of other tasks." class="class"></a><a href="TaskBundle.html" title="The packaging of a more complicated unit of work in a workflow in which one task relies on the successful completion of other tasks.">TaskBundle</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskNotExecutedException.html" title="" class="class"></a><a href="TaskNotExecutedException.html" title="">TaskNotExecutedException</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="TaskWorkflow$.html" title="" class="object"></a><a href="TaskWorkflow$.html" title="">TaskWorkflow</a></li><li class="current-entities indented4"><a href="UniqueNumberOps$.html" title="" class="object"></a> <a href="UniqueNumberOps.html" title="Wrap around converted NumberPools and synchronize a portion of the number registration process as a part of the global unique identifier (GUID, UID) number system (UNS, &quot;unique number system&quot;)." class="class"></a><a href="UniqueNumberOps.html" title="Wrap around converted NumberPools and synchronize a portion of the number registration process as a part of the global unique identifier (GUID, UID) number system (UNS, &quot;unique number system&quot;).">UniqueNumberOps</a></li><li class="current-entities indented4"><a href="UniqueNumberSetup$.html" title="" class="object"></a> <a href="UniqueNumberSetup.html" title="A class for spawning Actors to manage the number pools and create a number system operations class to access those pools within the context of registering and unregistering." class="class"></a><a href="UniqueNumberSetup.html" title="A class for spawning Actors to manage the number pools and create a number system operations class to access those pools within the context of registering and unregistering.">UniqueNumberSetup</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="UnregisteringException.html" title="" class="class"></a><a href="UnregisteringException.html" title="">UnregisteringException</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><div class="big-circle class">c</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>NumberPoolHub<span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">NumberPoolHub</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></h4><div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A master object that manages <code>NumberPool</code>s when they are applied to a single <code>NumberSource</code>.
It catalogs the numbers and ensures the pool contents are unique to each other.<br>
<br>
All globally unique numbers are sorted into user-defined groups called pools.
Pools are intended to pre-allocate certain numbers to certain tasks.
Two default pools also exist - "generic," for all numbers not formally placed into a pool, and a hidden restricted pool.
The former can accept a variety of numbers on the source not known at initialization time loaded into it.
The latter can only be set by the <code>NumberSource</code> and can not be affected once this object is created.</p></div><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/objects/guid/NumberPoolHub.scala" target="_blank">NumberPoolHub.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></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><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.objects.guid.NumberPoolHub"><span>NumberPoolHub</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</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="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#&lt;init&gt;" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="&lt;init&gt;(source:net.psforever.objects.guid.source.NumberSource):net.psforever.objects.guid.NumberPoolHub"></a><a id="&lt;init&gt;:NumberPoolHub"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#&lt;init&gt;(source:net.psforever.objects.guid.source.NumberSource):net.psforever.objects.guid.NumberPoolHub" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">NumberPoolHub</span><span class="params">(<span name="source">source: <a href="source/NumberSource.html" name="net.psforever.objects.guid.source.NumberSource" id="net.psforever.objects.guid.source.NumberSource" class="extype">NumberSource</a></span>)</span></span><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">source</dt><dd class="cmt"><p>the number source object</p></dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#AddPool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="AddPool(name:String,pool:List[Int]):net.psforever.objects.guid.pool.NumberPool"></a><a id="AddPool(String,List[Int]):NumberPool"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#AddPool(name:String,pool:List[Int]):net.psforever.objects.guid.pool.NumberPool" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">AddPool</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="pool">pool: <span name="scala.List" class="extype">List</span>[<span name="scala.Int" class="extype">Int</span>]</span>)</span><span class="result">: <a href="pool/NumberPool.html" name="net.psforever.objects.guid.pool.NumberPool" id="net.psforever.objects.guid.pool.NumberPool" class="extype">NumberPool</a></span></span><p class="shortcomment cmt">Create a new number pool with the given label and the given numbers.<br>
<br>
Creating number pools is a task that should only be performed at whatever counts as the initialization stage.</p><div class="fullcomment"><div class="comment cmt"><p>Create a new number pool with the given label and the given numbers.<br>
<br>
Creating number pools is a task that should only be performed at whatever counts as the initialization stage.
Nothing technically blocks it being done during runtime;
however, stability is best served by doing it only once and while nothing else risk affecting the numbers.
Unlike "live" functionality which often returns as <code>Success</code> or <code>Failure</code>, this is considered a critical operation.
As thus, <code>Exceptions</code> are permitted since a fault of the pool's creation will disrupt normal operations.</p></div><dl class="paramcmts block"><dt class="param">name</dt><dd class="cmt"><p>the name of the pool</p></dd><dt class="param">pool</dt><dd class="cmt"><p>the <code>List</code> of numbers that will belong to the pool</p></dd><dt>returns</dt><dd class="cmt"><p>the newly-created number pool</p></dd></dl><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="IllegalArgumentException" class="extype"><code>IllegalArgumentException</code></span> if the pool's name is already defined;
if the pool is (already) empty;
if the pool contains numbers the source does not;
if the pool contains numbers from already existing pools</p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#GetPool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="GetPool(name:String):Option[net.psforever.objects.guid.pool.NumberPool]"></a><a id="GetPool(String):Option[NumberPool]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#GetPool(name:String):Option[net.psforever.objects.guid.pool.NumberPool]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">GetPool</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="pool/NumberPool.html" name="net.psforever.objects.guid.pool.NumberPool" id="net.psforever.objects.guid.pool.NumberPool" class="extype">NumberPool</a>]</span></span><p class="shortcomment cmt">Get the number pool known by this name.</p><div class="fullcomment"><div class="comment cmt"><p>Get the number pool known by this name.
It will not return correctly for any number that is in the "restricted" pool.</p></div><dl class="paramcmts block"><dt class="param">name</dt><dd class="cmt"><p>the name of the pool</p></dd><dt>returns</dt><dd class="cmt"><p>a reference to the number pool, or <code>None</code></p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#Numbers" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="Numbers:List[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#Numbers:List[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Numbers</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Int" class="extype">Int</span>]</span></span></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#Pools" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Pools:scala.collection.mutable.HashMap[String,net.psforever.objects.guid.pool.NumberPool]"></a><a id="Pools:HashMap[String,NumberPool]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#Pools:scala.collection.mutable.HashMap[String,net.psforever.objects.guid.pool.NumberPool]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Pools</span><span class="result">: <span name="scala.collection.mutable.HashMap" class="extype">HashMap</span>[<span name="scala.Predef.String" class="extype">String</span>, <a href="pool/NumberPool.html" name="net.psforever.objects.guid.pool.NumberPool" id="net.psforever.objects.guid.pool.NumberPool" class="extype">NumberPool</a>]</span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt>returns</dt><dd class="cmt"><p>na</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#RemovePool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="RemovePool(name:String):List[Int]"></a><a id="RemovePool(String):List[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#RemovePool(name:String):List[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">RemovePool</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.List" class="extype">List</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Remove an existing number pool with the given label from the list of number pools.<br>
<br>
Removing number pools is a task that should only be performed at whatever counts as the termination stage.</p><div class="fullcomment"><div class="comment cmt"><p>Remove an existing number pool with the given label from the list of number pools.<br>
<br>
Removing number pools is a task that should only be performed at whatever counts as the termination stage.
All the same reasoning applies as with <code>AddPool</code> above.
Although an easy operation would move all the assigned numbers in the removing pool to the "generic" pool,
doing so is ill-advised both for the reasoning above and because that creates unreliability.</p></div><dl class="paramcmts block"><dt class="param">name</dt><dd class="cmt"><p>the name of the pool</p></dd><dt>returns</dt><dd class="cmt"><p>the <code>List</code> of numbers that belonged to the pool</p></dd></dl><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="IllegalArgumentException" class="extype"><code>IllegalArgumentException</code></span> if the pool doesn't exist or is not removed (removable)</p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#WhichPool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WhichPool(obj:net.psforever.objects.entity.IdentifiableEntity):Option[String]"></a><a id="WhichPool(IdentifiableEntity):Option[String]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#WhichPool(obj:net.psforever.objects.entity.IdentifiableEntity):Option[String]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">WhichPool</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><p class="shortcomment cmt">Reference a specific number's pool.<br>
<br>
<code>WhichPool(IdentifiableEntity)</code> does require the object to be registered to be found.</p><div class="fullcomment"><div class="comment cmt"><p>Reference a specific number's pool.<br>
<br>
<code>WhichPool(IdentifiableEntity)</code> does require the object to be registered to be found.
It checks that the object is registered, and that it is registered to the local source object.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object</p></dd><dt>returns</dt><dd class="cmt"><p>the name of the number pool to which this item belongs</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#WhichPool" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="WhichPool(number:Int):Option[String]"></a><a id="WhichPool(Int):Option[String]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#WhichPool(number:Int):Option[String]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">WhichPool</span><span class="params">(<span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<span name="scala.Predef.String" class="extype">String</span>]</span></span><p class="shortcomment cmt">Reference a specific number's pool.<br>
<br>
<code>WhichPool(Int)</code> does not require the number to be registered at the time it is used.</p><div class="fullcomment"><div class="comment cmt"><p>Reference a specific number's pool.<br>
<br>
<code>WhichPool(Int)</code> does not require the number to be registered at the time it is used.
It does not return anything for an unregistered unpooled number -
a number that would be part of the "generic" nonstandard pool.
It only reports "generic" if that number is registered.
It will not return correctly for any number that is in the "restricted" pool.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>a number</p></dd><dt>returns</dt><dd class="cmt"><p>the name of the number pool to which this item belongs</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#apply" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="apply(number:Int):Option[net.psforever.objects.entity.IdentifiableEntity]"></a><a id="apply(Int):Option[IdentifiableEntity]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#apply(number:Int):Option[net.psforever.objects.entity.IdentifiableEntity]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">apply</span><span class="params">(<span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>]</span></span><p class="shortcomment cmt">Given a globally unique identifier, return any object registered to it.<br>
<br>
Use:<br>
For <code>val obj = new NumberPoolHub(...)</code> use <code>obj(number)</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Given a globally unique identifier, return any object registered to it.<br>
<br>
Use:<br>
For <code>val obj = new NumberPoolHub(...)</code> use <code>obj(number)</code>.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>the unique number to attempt to retrieve from the <code>source</code></p></dd><dt>returns</dt><dd class="cmt"><p>the object that is assigned to the number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#apply" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="apply(number:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.entity.IdentifiableEntity]"></a><a id="apply(PlanetSideGUID):Option[IdentifiableEntity]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#apply(number:net.psforever.types.PlanetSideGUID):Option[net.psforever.objects.entity.IdentifiableEntity]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">apply</span><span class="params">(<span name="number">number: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>)</span><span class="result">: <span name="scala.Option" class="extype">Option</span>[<a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>]</span></span><p class="shortcomment cmt">Given a globally unique identifier, return any object registered to it.<br>
<br>
Use:<br>
For <code>val obj = new NumberPoolHub(...)</code> use <code>obj(number)</code>.</p><div class="fullcomment"><div class="comment cmt"><p>Given a globally unique identifier, return any object registered to it.<br>
<br>
Use:<br>
For <code>val obj = new NumberPoolHub(...)</code> use <code>obj(number)</code>.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>the unique number to attempt to retrieve from the <code>source</code></p></dd><dt>returns</dt><dd class="cmt"><p>the object that is assigned to the number</p></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#finalize():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_&lt;:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#getClass():Class[_]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ &lt;: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#hashCode():Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#isInstanceOf[T0]:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#isRegistered" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isRegistered(number:Int):Boolean"></a><a id="isRegistered(Int):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#isRegistered(number:Int):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isRegistered</span><span class="params">(<span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Determines if the number is registered.<br>
<br>
Two conditions are necessary to determine this condition for numbers.</p><div class="fullcomment"><div class="comment cmt"><p>Determines if the number is registered.<br>
<br>
Two conditions are necessary to determine this condition for numbers.
(1) A registered number is known to the <code>source</code>.
(2) A register number is known as <code>Leased</code> to the <code>source</code>.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>the number previously assigned(?)</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the number is registered; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>isRegistered(IdentifiableEntity)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#isRegistered" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isRegistered(obj:net.psforever.objects.entity.IdentifiableEntity):Boolean"></a><a id="isRegistered(IdentifiableEntity):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#isRegistered(obj:net.psforever.objects.entity.IdentifiableEntity):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isRegistered</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><p class="shortcomment cmt">Determines if the object is registered.<br>
<br>
Three conditions are necessary to determine this condition for objects.</p><div class="fullcomment"><div class="comment cmt"><p>Determines if the object is registered.<br>
<br>
Three conditions are necessary to determine this condition for objects.
(1) A registered object has a globally unique identifier.
(2) A registered object is known to the <code>source</code> by that identifier.
(3) The registered object can be found attached to that entry from the source.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object</p></dd><dt>returns</dt><dd class="cmt"><p><code>true</code>, if the number is registered; <code>false</code>, otherwise</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>isRegistered(Int)</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#ne(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#notify():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#notifyAll():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#register" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="register(name:String):scala.util.Try[net.psforever.objects.guid.key.LoanedKey]"></a><a id="register(String):Try[LoanedKey]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#register(name:String):scala.util.Try[net.psforever.objects.guid.key.LoanedKey]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">register</span><span class="params">(<span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<a href="key/LoanedKey.html" name="net.psforever.objects.guid.key.LoanedKey" id="net.psforever.objects.guid.key.LoanedKey" class="extype">LoanedKey</a>]</span></span><p class="shortcomment cmt">Register a number selected automatically from the named pool.</p><div class="fullcomment"><div class="comment cmt"><p>Register a number selected automatically from the named pool.</p></div><dl class="paramcmts block"><dt class="param">name</dt><dd class="cmt"><p>the local pool name</p></dd><dt>returns</dt><dd class="cmt"><p>the monitor for a number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#register" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="register(number:Int):scala.util.Try[net.psforever.objects.guid.key.LoanedKey]"></a><a id="register(Int):Try[LoanedKey]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#register(number:Int):scala.util.Try[net.psforever.objects.guid.key.LoanedKey]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">register</span><span class="params">(<span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<a href="key/LoanedKey.html" name="net.psforever.objects.guid.key.LoanedKey" id="net.psforever.objects.guid.key.LoanedKey" class="extype">LoanedKey</a>]</span></span><p class="shortcomment cmt">Register a specific number.</p><div class="fullcomment"><div class="comment cmt"><p>Register a specific number.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>the number whose assignment is requested</p></dd><dt>returns</dt><dd class="cmt"><p>the monitor for a number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#register" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="register(obj:net.psforever.objects.entity.IdentifiableEntity,name:String):scala.util.Try[Int]"></a><a id="register(IdentifiableEntity,String):Try[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#register(obj:net.psforever.objects.entity.IdentifiableEntity,name:String):scala.util.Try[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">register</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>, <span name="name">name: <span name="scala.Predef.String" class="extype">String</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Register an object to a specific number pool.</p><div class="fullcomment"><div class="comment cmt"><p>Register an object to a specific number pool.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object being registered</p></dd><dt class="param">name</dt><dd class="cmt"><p>the local pool name</p></dd><dt>returns</dt><dd class="cmt"><p>the number the was given to the object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#register" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="register(obj:net.psforever.objects.entity.IdentifiableEntity,number:Int):scala.util.Try[Int]"></a><a id="register(IdentifiableEntity,Int):Try[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#register(obj:net.psforever.objects.entity.IdentifiableEntity,number:Int):scala.util.Try[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">register</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>, <span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Register an object to a specific number if it is available.</p><div class="fullcomment"><div class="comment cmt"><p>Register an object to a specific number if it is available.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object being registered</p></dd><dt class="param">number</dt><dd class="cmt"><p>the number whose assignment is requested</p></dd><dt>returns</dt><dd class="cmt"><p>the number the was given to the object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#register" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="register(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[Int]"></a><a id="register(IdentifiableEntity):Try[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#register(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">register</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Register an object to any available selection (of the "generic" number pool).</p><div class="fullcomment"><div class="comment cmt"><p>Register an object to any available selection (of the "generic" number pool).</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object being registered</p></dd><dt>returns</dt><dd class="cmt"><p>the number the was given to the object</p></dd></dl></div></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=&gt;T0):T0"></a><a id="synchronized[T0](=&gt;T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#synchronized[T0](x$1:=&gt;T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: =&gt; <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#toString():String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#unregister" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unregister(number:Int):scala.util.Try[Option[net.psforever.objects.entity.IdentifiableEntity]]"></a><a id="unregister(Int):Try[Option[IdentifiableEntity]]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#unregister(number:Int):scala.util.Try[Option[net.psforever.objects.entity.IdentifiableEntity]]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">unregister</span><span class="params">(<span name="number">number: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Option" class="extype">Option</span>[<a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a>]]</span></span><p class="shortcomment cmt">Unregister a specific number.</p><div class="fullcomment"><div class="comment cmt"><p>Unregister a specific number.</p></div><dl class="paramcmts block"><dt class="param">number</dt><dd class="cmt"><p>the number previously assigned(?)</p></dd><dt>returns</dt><dd class="cmt"><p>the object, if any, previous associated with the number</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#unregister" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unregister(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[Int]"></a><a id="unregister(IdentifiableEntity):Try[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#unregister(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">unregister</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Unregister a specific object.</p><div class="fullcomment"><div class="comment cmt"><p>Unregister a specific object.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object being unregistered</p></dd><dt>returns</dt><dd class="cmt"><p>the number previously associated with the object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#unregister_GetMonitorFromObject" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="unregister_GetMonitorFromObject(obj:net.psforever.objects.entity.IdentifiableEntity,msg:String):scala.util.Try[Int]"></a><a id="unregister_GetMonitorFromObject(IdentifiableEntity,String):Try[Int]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#unregister_GetMonitorFromObject(obj:net.psforever.objects.entity.IdentifiableEntity,msg:String):scala.util.Try[Int]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">unregister_GetMonitorFromObject</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>, <span name="msg">msg: <span name="scala.Predef.String" class="extype">String</span> = <span class="symbol">"can not find this object"</span></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<span name="scala.Int" class="extype">Int</span>]</span></span><p class="shortcomment cmt">Unregister a specific object
by actually finding the object itself, if it exists.</p><div class="fullcomment"><div class="comment cmt"><p>Unregister a specific object
by actually finding the object itself, if it exists.</p></div><dl class="paramcmts block"><dt class="param">obj</dt><dd class="cmt"><p>an object being unregistered</p></dd><dt class="param">msg</dt><dd class="cmt"><p>custom error message;
has a vague default</p></dd><dt>returns</dt><dd class="cmt"><p>the number associated with this object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.guid.NumberPoolHub#unregister_GetPoolFromObject" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="unregister_GetPoolFromObject(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[net.psforever.objects.guid.pool.NumberPool]"></a><a id="unregister_GetPoolFromObject(IdentifiableEntity):Try[NumberPool]"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#unregister_GetPoolFromObject(obj:net.psforever.objects.entity.IdentifiableEntity):scala.util.Try[net.psforever.objects.guid.pool.NumberPool]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">unregister_GetPoolFromObject</span><span class="params">(<span name="obj">obj: <a href="../entity/IdentifiableEntity.html" name="net.psforever.objects.entity.IdentifiableEntity" id="net.psforever.objects.entity.IdentifiableEntity" class="extype">IdentifiableEntity</a></span>)</span><span class="result">: <span name="scala.util.Try" class="extype">Try</span>[<a href="pool/NumberPool.html" name="net.psforever.objects.guid.pool.NumberPool" id="net.psforever.objects.guid.pool.NumberPool" class="extype">NumberPool</a>]</span></span></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/objects/guid/NumberPoolHub.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></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