new NameMap()
NameMap
used for managing a list of String
names to Format
values.
This Constructor shouldn't be invoked directly. Please use the make()
methods to create an instance of a NameMap
Object.
Extends
Members
-
<static> DEFAULT :baja.NameMap
-
NameMap
default instanceType:
Methods
-
<static> make(map)
-
Make a
NameMap
object.Parameters:
Name Type Description map
Object an object containing key/value pairs.
Returns:
- Type
- baja.NameMap
-
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()
-
Decode
NameMap
from aString
.- Overrides:
Returns:
- Type
- baja.NameMap
-
encodeToString()
-
Encode
NameMap
to aString
.- Overrides:
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- Inherited From:
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
-
get()
-
Return a
Format
from the Map or null if an entry can't be found.Returns:
or null if an entry can't be found.
- Type
- baja.Format
-
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
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
list()
-
Return a list of all the keys in the Map.
Returns:
an array of String key names.
-
make(map)
-
Make a
NameMap
object.Parameters:
Name Type Description map
Object an object containing key/value pairs.
- Overrides:
Returns:
- Type
- baja.NameMap
-
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()
-
Return a
String
representation of theNameMap
.- Overrides:
Returns:
- Type
- String
-
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
- *