NumberPoolHub

Instance Constructors

new NumberPoolHub(source: NumberSource)

source
the number source object

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from NumberPoolHub to any2stringadd[NumberPoolHub] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (NumberPoolHub, B)

Implicit information
This member is added by an implicit conversion from NumberPoolHub to ArrowAssoc[NumberPoolHub] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def AddPool(name: String, pool: List[Int]): NumberPool

Create a new number pool with the given label and the given numbers.

Creating number pools is a task that should only be performed at whatever counts as the initialization stage.
Create a new number pool with the given label and the given numbers.

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 Success or Failure, this is considered a critical operation. As thus, Exceptions are permitted since a fault of the pool's creation will disrupt normal operations.
name
the name of the pool
pool
the List of numbers that will belong to the pool
returns
the newly-created number pool

Exceptions thrown
IllegalArgumentException 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
def GetPool(name: String): Option[NumberPool]

Get the number pool known by this name.
Get the number pool known by this name. It will not return correctly for any number that is in the "restricted" pool.
name
the name of the pool
returns
a reference to the number pool, or None
def Numbers: List[Int]
def Pools: HashMap[String, NumberPool]

na
na
returns
na
def RemovePool(name: String): List[Int]

Remove an existing number pool with the given label from the list of number pools.

Removing number pools is a task that should only be performed at whatever counts as the termination stage.
Remove an existing number pool with the given label from the list of number pools.

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 AddPool 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.
name
the name of the pool
returns
the List of numbers that belonged to the pool

Exceptions thrown
IllegalArgumentException if the pool doesn't exist or is not removed (removable)
def WhichPool(obj: IdentifiableEntity): Option[String]

Reference a specific number's pool.

WhichPool(IdentifiableEntity) does require the object to be registered to be found.
Reference a specific number's pool.

WhichPool(IdentifiableEntity) 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.
obj
an object
returns
the name of the number pool to which this item belongs
def WhichPool(number: Int): Option[String]

Reference a specific number's pool.

WhichPool(Int) does not require the number to be registered at the time it is used.
Reference a specific number's pool.

WhichPool(Int) 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.
number
a number
returns
the name of the number pool to which this item belongs
def apply(number: Int): Option[IdentifiableEntity]

Given a globally unique identifier, rweturn any object registered to it.

Use:
For val obj = new NumberPoolHub(...) use obj(number).
Given a globally unique identifier, rweturn any object registered to it.

Use:
For val obj = new NumberPoolHub(...) use obj(number).
number
the unique number to attempt to retrieve from the source
returns
the object that is assigned to the number
def apply(number: PlanetSideGUID): Option[IdentifiableEntity]

Given a globally unique identifier, rweturn any object registered to it.

Use:
For val obj = new NumberPoolHub(...) use obj(number).
Given a globally unique identifier, rweturn any object registered to it.

Use:
For val obj = new NumberPoolHub(...) use obj(number).
number
the unique number to attempt to retrieve from the source
returns
the object that is assigned to the number
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (NumberPoolHub) ⇒ Boolean, msg: ⇒ Any): NumberPoolHub

Implicit information
This member is added by an implicit conversion from NumberPoolHub to Ensuring[NumberPoolHub] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (NumberPoolHub) ⇒ Boolean): NumberPoolHub

Implicit information
This member is added by an implicit conversion from NumberPoolHub to Ensuring[NumberPoolHub] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): NumberPoolHub

Implicit information
This member is added by an implicit conversion from NumberPoolHub to Ensuring[NumberPoolHub] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): NumberPoolHub

Implicit information
This member is added by an implicit conversion from NumberPoolHub to Ensuring[NumberPoolHub] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from NumberPoolHub to StringFormat[NumberPoolHub] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isRegistered(number: Int): Boolean

Determines if the number is registered.

Two conditions are necessary to determine this condition for numbers.
Determines if the number is registered.

Two conditions are necessary to determine this condition for numbers. (1) A registered number is known to the source. (2) A register number is known as Leased to the source.
number
the number previously assigned(?)
returns
true, if the number is registered; false, otherwise

See also
isRegistered(IdentifiableEntity)
def isRegistered(obj: IdentifiableEntity): Boolean

Determines if the object is registered.

Three conditions are necessary to determine this condition for objects.
Determines if the object is registered.

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 source by that identifier. (3) The registered object can be found attached to that entry from the source.
obj
an object
returns
true, if the number is registered; false, otherwise

See also
isRegistered(Int)
def latterPartRegister(obj: IdentifiableEntity, number: Int): Try[IdentifiableEntity]

na
na
obj
an object being registered
number
the number whose assignment is requested
returns
an object that has been registered
def latterPartUnregister(number: Int): Option[IdentifiableEntity]

For accessing the Return function of the contained NumberSource directly.
For accessing the Return function of the contained NumberSource directly.
number
the number to return.
returns
any object previously using this number
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def register(name: String): Try[LoanedKey]

Register a number selected automatically from the named pool.
Register a number selected automatically from the named pool.
name
the local pool name
returns
the monitor for a number
def register(number: Int): Try[LoanedKey]

Register a specific number.
Register a specific number.
number
the number whose assignment is requested
returns
the monitor for a number
def register(obj: IdentifiableEntity, name: String): Try[Int]

Register an object to a specific number pool.
Register an object to a specific number pool.
obj
an object being registered
name
the local pool name
returns
the number the was given to the object
def register(obj: IdentifiableEntity, number: Int): Try[Int]

Register an object to a specific number if it is available.
Register an object to a specific number if it is available.
obj
an object being registered
number
the number whose assignment is requested
returns
the number the was given to the object
def register(obj: IdentifiableEntity): Try[Int]

Register an object to any available selection (of the "generic" number pool).
Register an object to any available selection (of the "generic" number pool).
obj
an object being registered
returns
the number the was given to the object
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unregister(number: Int): Try[Option[IdentifiableEntity]]

Unregister a specific number.
Unregister a specific number.
number
the number previously assigned(?)
returns
the object, if any, previous associated with the number
def unregister(obj: IdentifiableEntity): Try[Int]

Unregister a specific object.
Unregister a specific object.
obj
an object being unregistered
returns
the number previously associated with the object
def unregister_GetPoolFromObject(obj: IdentifiableEntity): Try[NumberPool]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (NumberPoolHub, B)

Implicit information
This member is added by an implicit conversion from NumberPoolHub to ArrowAssoc[NumberPoolHub] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from NumberPoolHub to any2stringadd[NumberPoolHub]

Inherited by implicit conversion StringFormat from NumberPoolHub to StringFormat[NumberPoolHub]

Inherited by implicit conversion Ensuring from NumberPoolHub to Ensuring[NumberPoolHub]

Inherited by implicit conversion ArrowAssoc from NumberPoolHub to ArrowAssoc[NumberPoolHub]

Ungrouped

Related Doc: package guid

class NumberPoolHub extends AnyRef

Instance Constructors

new NumberPoolHub(source: NumberSource)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (NumberPoolHub, B)

final def ==(arg0: Any): Boolean

def AddPool(name: String, pool: List[Int]): NumberPool

def GetPool(name: String): Option[NumberPool]

def Numbers: List[Int]

def Pools: HashMap[String, NumberPool]

def RemovePool(name: String): List[Int]

def WhichPool(obj: IdentifiableEntity): Option[String]

def WhichPool(number: Int): Option[String]

def apply(number: Int): Option[IdentifiableEntity]

def apply(number: PlanetSideGUID): Option[IdentifiableEntity]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (NumberPoolHub) ⇒ Boolean, msg: ⇒ Any): NumberPoolHub

def ensuring(cond: (NumberPoolHub) ⇒ Boolean): NumberPoolHub

def ensuring(cond: Boolean, msg: ⇒ Any): NumberPoolHub

def ensuring(cond: Boolean): NumberPoolHub

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isRegistered(number: Int): Boolean

def isRegistered(obj: IdentifiableEntity): Boolean

def latterPartRegister(obj: IdentifiableEntity, number: Int): Try[IdentifiableEntity]

def latterPartUnregister(number: Int): Option[IdentifiableEntity]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def register(name: String): Try[LoanedKey]

def register(number: Int): Try[LoanedKey]

def register(obj: IdentifiableEntity, name: String): Try[Int]

def register(obj: IdentifiableEntity, number: Int): Try[Int]

def register(obj: IdentifiableEntity): Try[Int]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unregister(number: Int): Try[Option[IdentifiableEntity]]

def unregister(obj: IdentifiableEntity): Try[Int]

def unregister_GetPoolFromObject(obj: IdentifiableEntity): Try[NumberPool]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (NumberPoolHub, B)

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from NumberPoolHub to any2stringadd[NumberPoolHub]

Inherited by implicit conversion StringFormat from NumberPoolHub to StringFormat[NumberPoolHub]

Inherited by implicit conversion Ensuring from NumberPoolHub to Ensuring[NumberPoolHub]

Inherited by implicit conversion ArrowAssoc from NumberPoolHub to ArrowAssoc[NumberPoolHub]

Ungrouped