UnsignedLong (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- java.lang.Number
- - com.prosysopc.ua.stack.builtintypes.UnsignedLong

All Implemented Interfaces:

BitField, Serializable, Comparable<Number>
```
public final class UnsignedLong
extends Number
implements Comparable<Number>, BitField
```
Unsigned Long represents an integer number value between 0 .. and 0xFFFFFFFFFFFFFFFF (18446744073709551615). This class is immutable, instances should be constructed with the static factory methods. This class is mapped to OPC UA DataType UInt64.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static UnsignedLong[]`	`EMPTY_ARRAY`
`static NodeId`	`ID` Deprecated. use `Identifiers.UInt64` instead.
`static UnsignedLong`	`MAX_VALUE`
`static UnsignedLong`	`MIN_VALUE`
`static UnsignedLong`	`ONE`
`static int`	`SIZE`
`static UnsignedLong`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`UnsignedLong(BigInteger value)` Deprecated. use `valueOf(BigInteger)` instead.
`UnsignedLong(int value)` Deprecated. use `valueOf(long)` instead.
`UnsignedLong(long value)` Deprecated. use `valueOf(long)` instead.
`UnsignedLong(String value)` Deprecated. use `valueOf(String)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnsignedLong`	`add(long increment)` Add a value.
`UnsignedLong`	`add(UnsignedLong increment)` Add a value.
`static UnsignedLong[]`	`arrayOf()` Returns an empty UnsignedLong array.
`static UnsignedLong[]`	`arrayOf(BigInteger... elements)` Returns an UnsignedLong array from the given elements.
`static UnsignedLong[]`	`arrayOf(long... elements)` Returns an UnsignedLong array with the given elements.
`static UnsignedLong[]`	`arrayOf(String... elements)` Returns an UnsignedLong array with the given elements.
`BigInteger`	`bigIntegerValue()` bigIntegerValue.
`int`	`compareTo(Number other)` compareTo.
`UnsignedLong`	`dec()` Decrease the value by one.
`UnsignedLong`	`decOrWrap()` If equals `MIN_VALUE`, returns `MAX_VALUE`, otherwise return value - 1.
`UnsignedLong`	`decOrWrapTo(UnsignedLong target)` If equals `MIN_VALUE`, returns the given target, otherwise return value - 1.
`double`	`doubleValue()`
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`static UnsignedLong`	`getFromBits(long bits)` Create unsigned long from 64 bits.
`int`	`hashCode()`
`UnsignedLong`	`inc()` Increase the value by one.
`UnsignedLong`	`incOrWrap()` If equals `MAX_VALUE`, returns `MIN_VALUE`, otherwise return value + 1.
`UnsignedLong`	`incOrWrapTo(UnsignedLong target)` If equals `MAX_VALUE`, returns the given target, otherwise return value + 1.
`int`	`intValue()`
`boolean`	`isBitSet(int position)` Is bit set in position.
`long`	`longValue()`
`static UnsignedLong`	`parseUnsignedLong(String string)` Parse an UnsignedLong value from a string.
`static UnsignedLong`	`parseUnsignedLong(String string, int radix)` Parses the string argument as an unsigned long similar to `Integer.parseInt(String, int)`.
`UnsignedLong`	`subtract(long decrement)` Subtract a value from this value.
`UnsignedLong`	`subtract(UnsignedLong decrement)` Subtract a value from this value.
`String`	`toHex()` Convert the value to a hexadecimal string.
`long`	`toLongBits()` toLongBits.
`String`	`toString()`
`static UnsignedLong`	`valueOf(BigInteger value)` Get cached or new instance.
`static UnsignedLong`	`valueOf(long value)` Get cached or create new instance.
`static UnsignedLong`	`valueOf(String string)` Parses `UnsignedLong` from String.
`static UnsignedLong`	`valueOf(String string, int radix)` Parses `UnsignedLong` from String.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.UInt64 instead.
    
    The NodeId for the DataType node UInt64 in the UA AddressSpace.
  - SIZE
```
public static final int SIZE
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE
```
public static final UnsignedLong MAX_VALUE
```
  - MIN_VALUE
```
public static final UnsignedLong MIN_VALUE
```
  - ZERO
```
public static final UnsignedLong ZERO
```
  - ONE
```
public static final UnsignedLong ONE
```
  - EMPTY_ARRAY
```
public static final UnsignedLong[] EMPTY_ARRAY
```
- Constructor Detail
  - UnsignedLong
```
@Deprecated
public UnsignedLong(BigInteger value)
                          throws IllegalArgumentException
```
    Deprecated. use valueOf(BigInteger) instead.
    
    Constructor for UnsignedLong.
    
    Parameters:
    
    value - a BigInteger object.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedLong
```
@Deprecated
public UnsignedLong(int value)
```
    Deprecated. use valueOf(long) instead.
    
    Constructor for UnsignedLong.
    
    Parameters:
    
    value - a int.
  - UnsignedLong
```
@Deprecated
public UnsignedLong(long value)
```
    Deprecated. use valueOf(long) instead.
    
    Construct UnsignedLong from long. If long is negative, its upper bit is intrepreted as 0x8000000000000000.
    
    Parameters:
    
    value - a long.
  - UnsignedLong
```
@Deprecated
public UnsignedLong(String value)
```
    Deprecated. use valueOf(String) instead.
    
    Constructor for UnsignedLong.
    
    Parameters:
    
    value - a String object.
- Method Detail
  - arrayOf
```
public static UnsignedLong[] arrayOf()
```
    Returns an empty UnsignedLong array.
  - arrayOf
```
public static UnsignedLong[] arrayOf(BigInteger... elements)
```
    Returns an UnsignedLong array from the given elements. Each element is parsed with UnsignedShort#valueOf(BigInteger). If given null array for elements returns null.
  - arrayOf
```
public static UnsignedLong[] arrayOf(long... elements)
```
    Returns an UnsignedLong array with the given elements. Each element is parsed with valueOf(long). If given null array for elements returns null.
  - arrayOf
```
public static UnsignedLong[] arrayOf(String... elements)
```
    Returns an UnsignedLong array with the given elements. Each element is parsed with valueOf(String). If given null array for elements returns null.
  - getFromBits
```
public static UnsignedLong getFromBits(long bits)
```
    Create unsigned long from 64 bits.
    
    Parameters:
    
    bits - a long.
    
    Returns:
    
    new or cached instance
  - parseUnsignedLong
```
public static UnsignedLong parseUnsignedLong(String string)
```
    Parse an UnsignedLong value from a string.
    
    Parameters:
    
    string - the string to parse, assumed to contain a positive Long value
    
    Returns:
    
    the respective UnsignedInteger
  - parseUnsignedLong
```
public static UnsignedLong parseUnsignedLong(String string,
                                             int radix)
                                      throws NumberFormatException,
                                             IllegalArgumentException
```
    Parses the string argument as an unsigned long similar to Integer.parseInt(String, int).
    
    Parameters:
    
    string - the string to parse, assumed to contain a positive Long value
    
    radix - the radix to be used while parsing s.
    
    Returns:
    
    the respective UnsignedLong
    
    Throws:
    
    NumberFormatException - if the string cannot be parsed into an integer value
    
    IllegalArgumentException - if the parsed value does not fit in the range of UnsignedInteger
  - valueOf
```
public static UnsignedLong valueOf(BigInteger value)
```
    Get cached or new instance.
  - valueOf
```
public static UnsignedLong valueOf(long value)
```
    Get cached or create new instance.
    
    Parameters:
    
    value - a long.
    
    Returns:
    
    new or cached instance
  - valueOf
```
public static UnsignedLong valueOf(String string)
```
    Parses UnsignedLong from String. Behaves same as parseUnsignedLong(String).
  - valueOf
```
public static UnsignedLong valueOf(String string,
                                   int radix)
```
    Parses UnsignedLong from String. Behaves same as parseUnsignedLong(String, int).
  - add
```
public UnsignedLong add(long increment)
```
    Add a value. Note that this object is not changed, but a new one is created.
    
    Parameters:
    
    increment - the value to add to the current value
    
    Returns:
    
    a new UnsignedLong, increased by increment from this one.
  - add
```
public UnsignedLong add(UnsignedLong increment)
```
    Add a value. Note that this object is not changed, but a new one is created.
    
    Parameters:
    
    increment - the value to add to the current value
    
    Returns:
    
    a new UnsignedLong, increased by increment from this one.
  - bigIntegerValue
```
public BigInteger bigIntegerValue()
```
    bigIntegerValue.
    
    Returns:
    
    a BigInteger object.
  - compareTo
```
public int compareTo(Number other)
```
    compareTo.
    
    Specified by:
    
    compareTo in interface Comparable<Number>
    
    Parameters:
    
    other - a Number object.
    
    Returns:
    
    a int.
  - dec
```
public UnsignedLong dec()
```
    Decrease the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedLong, decreased by 1 from this one.
    
    Throws:
    
    IllegalArgumentException - if the value was 0 before the call
  - decOrWrap
```
public UnsignedLong decOrWrap()
```
    If equals MIN_VALUE, returns MAX_VALUE, otherwise return value - 1.
  - decOrWrapTo
```
public UnsignedLong decOrWrapTo(UnsignedLong target)
```
    If equals MIN_VALUE, returns the given target, otherwise return value - 1.
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class Number
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class Number
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - inc
```
public UnsignedLong inc()
```
    Increase the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedLong, increased by 1 from this one.
  - incOrWrap
```
public UnsignedLong incOrWrap()
```
    If equals MAX_VALUE, returns MIN_VALUE, otherwise return value + 1.
  - incOrWrapTo
```
public UnsignedLong incOrWrapTo(UnsignedLong target)
```
    If equals MAX_VALUE, returns the given target, otherwise return value + 1.
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class Number
  - isBitSet
```
public boolean isBitSet(int position)
```
    Description copied from interface: BitField
    
    Is bit set in position. Positions start from 0. Note that this method will return false for positions outside of range.
    
    Specified by:
    
    isBitSet in interface BitField
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class Number
  - subtract
```
public UnsignedLong subtract(long decrement)
```
    Subtract a value from this value. Note that this object is not changed, but a new one is created.
    
    Parameters:
    
    decrement - the value to subtract from the current value
    
    Returns:
    
    a new UnsignedLong, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - subtract
```
public UnsignedLong subtract(UnsignedLong decrement)
```
    Subtract a value from this value. Note that this object is not changed, but a new one is created.
    
    Parameters:
    
    decrement - the value to subtract from the current value
    
    Returns:
    
    a new UnsignedLong, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - toHex
```
public String toHex()
```
    Convert the value to a hexadecimal string.
    Uses CryptoUtil.toHex(long) to do the conversion.
  - toLongBits
```
public long toLongBits()
```
    toLongBits.
    
    Returns:
    
    a long.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UnsignedLong

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ID

SIZE

MAX_VALUE

MIN_VALUE

ZERO

ONE

EMPTY_ARRAY

Constructor Detail

UnsignedLong

UnsignedLong

UnsignedLong

UnsignedLong

Method Detail

arrayOf

arrayOf

arrayOf

arrayOf

getFromBits

parseUnsignedLong

parseUnsignedLong

valueOf

valueOf

valueOf

valueOf

add

add

bigIntegerValue

compareTo

dec

decOrWrap

decOrWrapTo

doubleValue

equals

floatValue

hashCode

inc

incOrWrap

incOrWrapTo

intValue

isBitSet

longValue

subtract

subtract

toHex

toLongBits

toString