new Long()
Represents a baja:Long
in BajaScript.
Boxes JavaScript Number
to represent a baja:Long
.
When creating a Simple
, always use the make()
method instead of
creating a new Object.
Extends
Members
-
<static> DEFAULT :baja.Long
-
Default
Long
instance.Type:
-
<static> MAX_VALUE :baja.Long
-
Long
Max Value.Type:
-
<static> MIN_VALUE :baja.Long
-
Long
Min Value.Type:
Methods
-
<static> make(val)
-
Make a
Long
.Parameters:
Name Type Description val
Number the number value.
Returns:
- Type
- baja.Long
-
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
Long
from aString
.Parameters:
Name Type Description str
String - Overrides:
Returns:
- Type
- baja.Long
-
encodeToString()
-
Encode the
Long
(itself) to aString
.- Overrides:
Returns:
- Type
- String
-
equals(obj)
-
Equality test.
Parameters:
Name Type Description obj
- 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
-
getDataTypeSymbol()
-
Return the data type symbol.
Used for encoding this data type (primarily for facets).
Returns:
- Type
- String
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
make(val)
-
Make a
Long
.Parameters:
Name Type Description val
Number the number value.
- Overrides:
Returns:
- Type
- baja.Long
-
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 theLong
(itself).Parameters:
Name Type Argument Description cx
baja.Facets | Object <optional>
used to specify formatting facets. The
argument can also be an Object Literal.Properties
Name Type Argument Description forceSign
Boolean <optional>
specifying 'true' will concatenate a '+'
to the beginning of the number if positive.showSeparators
Boolean <optional>
include separators.
radix
Number <optional>
specify the number base of the return string.
units
baja.Unit <optional>
the baja Unit to apply to the return
string.unitConversion
baja.Enum | Number | String <optional>
the
baja:UnitConversion
enum, an ordinal, or tag.zeroPad
Number <optional>
the minimum number of the whole-number
digits to be displayed, filling in zeroes when necessary.- Overrides:
Returns:
returns a Promise if a cx is passed in.
-
valueOf()
-
Return the
Number
encapsulated in theLong
(itself).- Overrides:
Returns:
- Type
- Number