mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-04-19 19:35:21 +00:00
29 lines
32 KiB
HTML
29 lines
32 KiB
HTML
|
<!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.entity</title><meta content="PSF - LoginServer - master - net.psforever.objects.entity" name="description"/><meta content="PSF LoginServer master net.psforever.objects.entity" 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"><</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.avatar" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="avatar"></a><a id="avatar:avatar"></a> <span class="permalink"><a href="../../../../net/psforever/objects/avatar/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="../avatar/index.html" title=""><span class="name">avatar</span></
|
||
|
|
<br>
|
||
|
|
The basic design philosophy of the workflow of a GUID at this stage is a deterministic state machine.</p><div class="fullcomment"><div class="comment cmt"><p>Represent any entity that must have its own valid global unique identifier (GUID) to be functional.<br>
|
||
|
|
<br>
|
||
|
|
The basic design philosophy of the workflow of a GUID at this stage is a deterministic state machine.
|
||
|
|
At the start, an <code>Exception</code> will be thrown while the default conditions of the accessor and mutator are maintained.
|
||
|
|
("The ability to set a new valid GUID".)
|
||
|
|
Only a valid GUID may be set and, once it does, that changes the conditions of the accessor and mutator
|
||
|
|
to one where it will return the valid GUID and one where it will no longer accept a new GUID (valid or invalid).
|
||
|
|
That GUID will continue being the GUID reported by the object, even if another valid GUID tries to be set.
|
||
|
|
(No error or exception will be thrown.)
|
||
|
|
To set a new GUID, the current one must be invalidated with the appropriate function,
|
||
|
|
and this turns both the object and any object reference that can be acquired from the object "stale."
|
||
|
|
Doing this prior to setting the initial valid GUID is fruitless
|
||
|
|
as it restores the object to its default mutation option ("the ability to set a new valid GUID").
|
||
|
|
Access to the GUID is retained.
|
||
|
|
This can be done as many times as is necessary by following the same order of actions.<br>
|
||
|
|
<br>
|
||
|
|
The "staleness" of the object and the "staleness" of the GUID are related.
|
||
|
|
The condition in general indicates that the object has somehow become externally disconnected from its GUID reference
|
||
|
|
though the two still share something similar to their prior relationship internally.
|
||
|
|
Do not expect a "stale" GUID to refer to the same object through some mapping mechanism.
|
||
|
|
Do not expect a "stale" object to give you a GUID that will map back to itself.</p></div><dl class="attributes block"><dt>Exceptions thrown</dt><dd><span class="cmt"><p><span name="`NoGUIDException`" class="extype"><code>`NoGUIDException`</code></span> if a GUID has not yet been assigned</p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.objects.entity.NoGUIDException" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NoGUIDExceptionextendsGUIDException"></a><a id="NoGUIDException:NoGUIDException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/NoGUIDException.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="NoGUIDException.html" title="The specific complaint for an instance where an entity does not possess a global unique identifier number but the said number is requested."><span class="name">NoGUIDException</span></a><span class="result"> extends <a href="GUIDException.html" name="net.psforever.objects.entity.GUIDException" id="net.psforever.objects.entity.GUIDException" class="extype">GUIDException</a></span></span><p class="shortcomment cmt">The specific complaint for an instance where an entity does not possess a global unique identifier number
|
||
|
|
but the said number is requested.</p><div class="fullcomment"><div class="comment cmt"><p>The specific complaint for an instance where an entity does not possess a global unique identifier number
|
||
|
|
but the said number is requested.
|
||
|
|
In general, this <code>Exception</code> is only thrown if the entity has never been registered,
|
||
|
|
or provided the bare minimum or registration benefits.</p></div></div></li><li class="indented0 " name="net.psforever.objects.entity.SimpleWorldEntity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SimpleWorldEntityextendsWorldEntity"></a><a id="SimpleWorldEntity:SimpleWorldEntity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/SimpleWorldEntity.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="SimpleWorldEntity.html" title=""><span class="name">SimpleWorldEntity</span></a><span class="result"> extends <a href="WorldEntity.html" name="net.psforever.objects.entity.WorldEntity" id="net.psforever.objects.entity.WorldEntity" class="extype">WorldEntity</a></span></span></li><li class="indented0 " name="net.psforever.objects.entity.WorldEntity" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="WorldEntityextendsAnyRef"></a><a id="WorldEntity:WorldEntity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/WorldEntity.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="WorldEntity.html" title=""><span class="name">WorldEntity</span></a><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="net.psforever.objects.entity.AssigningGUIDException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="AssigningGUIDException"></a><a id="AssigningGUIDException:AssigningGUIDException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/AssigningGUIDException$.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="AssigningGUIDException$.html" title=""><span class="name">AssigningGUIDException</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.entity.IdentifiableEntity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="IdentifiableEntity"></a><a id="IdentifiableEntity:IdentifiableEntity"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/IdentifiableEntity$.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="IdentifiableEntity$.html" title=""><span class="name">IdentifiableEntity</span></a></span></li><li class="indented0 " name="net.psforever.objects.entity.NoGUIDException" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NoGUIDException"></a><a id="NoGUIDException:NoGUIDException"></a> <span class="permalink"><a href="../../../../net/psforever/objects/entity/NoGUIDException$.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="NoGUIDException$.html" title=""><span class="name">NoGUIDException</span></a><span class="result"> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></span></span></li><li class="indented0 " name="net.psforever.objects.entity.SimpleWorldEntity" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SimpleWorldEntity"></a><a id="SimpleWorldEnt
|