new NameList()
A NameList
simply contains a set of name strings. Names must be validSlotPath
names.
Note that the actual behavior of this class is more of a set than a list,
but we conform with the class name in javax.baja.util
. Heigh ho.
Extends
Methods
-
<static> difference(a, b)
-
Create a new
NameList
which is the difference of the two name lists.Parameters:
Name Type Description a
baja.NameList b
baja.NameList Returns:
- Type
- baja.NameList
-
<static> intersection(a, b)
-
Create a new
NameList
which is the intersection of the two name lists.Parameters:
Name Type Description a
baja.NameList b
baja.NameList Returns:
- Type
- baja.NameList
-
<static> make(names)
-
Create a new
baja:NameList
instance from a name or set of names.Parameters:
Name Type Description names
String | Array.<String> a name, or array of names. These must
all be valid SlotPath names.Throws:
-
if names that are valid SlotPaths are not given
- Type
- Error
Returns:
- Type
- baja.NameList
-
-
<static> union(a, b)
-
Create a new
NameList
which is the union of the two name lists with no
duplicates.Parameters:
Name Type Description a
baja.NameList b
baja.NameList Returns:
- Type
- baja.NameList
-
decodeAsync(str [, batch])
-
The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.The default implementation just returns
decodeFromString
directly.Parameters:
Name Type Argument Description str
string batch
baja.comm.Batch <optional>
optional batch to use
- Inherited From:
Returns:
may return the Simple instance
directly, or a Promise resolving to same - so wrap inPromise.resolve()
if unsure.- Type
- baja.Simple | Promise.<baja.Simple>
-
decodeFromString(str)
-
Decode a
NameList
from a string.Parameters:
Name Type Description str
String - Overrides:
Returns:
- Type
- baja.NameList
-
difference(o)
-
Return the difference which is this
NameList
minus the names in the otherNameList
.Parameters:
Name Type Description o
baja.NameList Returns:
- Type
- baja.NameList
-
encodeToString()
-
Encode this
NameList
to a string.- Overrides:
Returns:
- Type
- String
-
equals(o)
-
Two
NameList
s are considered equal if they contain all the same strings,
not necessarily in the same order.Parameters:
Name Type Description o
baja.NameList - Overrides:
Returns:
- Type
- boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getNames()
-
Get the names contained by this
NameList
.Returns:
- Type
- Array.<String>
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
intersection(o)
-
Return the intersection of the names in this
NameList
and the otherNameList
.Parameters:
Name Type Description o
baja.NameList Returns:
- Type
- baja.NameList
-
make()
-
- Overrides:
- See:
-
- .make
Returns:
- Type
- baja.NameList
-
newCopy( [exact])
-
Every value may be cloned using the
newCopy
method.Please note that
Simple
s are immutable so they don't
allocate a new instance.Parameters:
Name Type Argument Description exact
Boolean <optional>
true if an exact copy of the value should be
made (only valid in the Component architecture).- Inherited From:
- See:
Returns:
a copy of the value (or the same instance if the value is a
Simple
). -
toString( [cx])
-
Returns the String representation of this object.
Parameters:
Name Type Argument Description cx
Object <optional>
optional context information to be used when
formatting the string- Inherited From:
- See:
Returns:
a string (if no context passed), or
either a string or a Promise (if context passed). -
union(o)
-
Return the union of the names in this
NameList
plus the names in the
otherNameList
, with no duplicates.Parameters:
Name Type Description o
baja.NameList Returns:
- Type
- baja.NameList
-
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *