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

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

All Implemented Interfaces:

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

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static UnsignedInteger[]`	`EMPTY_ARRAY`
`static long`	`L_MAX_VALUE`
`static long`	`L_MIN_VALUE`
`static UnsignedInteger`	`MAX_VALUE`
`static UnsignedInteger`	`MIN_VALUE`
`static UnsignedInteger`	`ONE`
`static UnsignedInteger`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`UnsignedInteger()` Deprecated. use `ZERO` instead.
`UnsignedInteger(int value)` Deprecated. use `valueOf(long)` instead.
`UnsignedInteger(long value)` Deprecated. `valueOf(long)` instead.
`UnsignedInteger(String value)` Deprecated. use `valueOf(String)` instead.
`UnsignedInteger(UnsignedByte value)` Deprecated. use `valueOf(UnsignedByte)` instead.
`UnsignedInteger(UnsignedInteger value)` Deprecated. should not be used. Use the given value directly as `UnsignedInteger`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnsignedInteger`	`add(int increment)` Add a value.
`UnsignedInteger`	`add(long increment)` Add a value.
`UnsignedInteger`	`add(UnsignedInteger increment)` Add a value.
`UnsignedInteger`	`and(int value)` and.
`UnsignedInteger`	`and(long value)` and.
`UnsignedInteger`	`and(UnsignedInteger value)` and.
`static UnsignedInteger[]`	`arrayOf()` Returns an empty UnsignedInteger array.
`static UnsignedInteger[]`	`arrayOf(long... elements)` Returns an UnsignedInteger array with the given elements.
`static UnsignedInteger[]`	`arrayOf(String... elements)` Returns an UnsignedInteger array with the given elements.
`byte`	`byteValue()`
`static UnsignedInteger`	`clamp(UnsignedInteger value, UnsignedInteger min, UnsignedInteger max)` Clamps the given value to fit between min and max.
`int`	`compareTo(Number other)`
`UnsignedInteger`	`dec()` Decrease the value by one.
`UnsignedInteger`	`decOrWrap()` If equals `MIN_VALUE`, returns `MAX_VALUE`, otherwise return value - 1.
`UnsignedInteger`	`decOrWrapTo(UnsignedInteger target)` If equals `MIN_VALUE`, returns the given target, otherwise return value - 1.
`double`	`doubleValue()`
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`static UnsignedInteger`	`getFromBits(int value)` getFromBits.
`long`	`getValue()` Getter for the field `value`.
`int`	`hashCode()`
`UnsignedInteger`	`inc()` Increase the value by one.
`UnsignedInteger`	`incOrWrap()` If equals `MAX_VALUE`, returns `MIN_VALUE`, otherwise return value + 1.
`UnsignedInteger`	`incOrWrapTo(UnsignedInteger 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 UnsignedInteger`	`max(UnsignedInteger v0, UnsignedInteger v1)` max.
`static UnsignedInteger`	`min(UnsignedInteger v0, UnsignedInteger v1)` min.
`UnsignedInteger`	`or(int value)` or.
`UnsignedInteger`	`or(long value)` or.
`UnsignedInteger`	`or(UnsignedInteger value)` or.
`static UnsignedInteger`	`parseUnsignedInteger(String string)` Parse an UnsignedInteger value from a string.
`static UnsignedInteger`	`parseUnsignedInteger(String string, int radix)` Parses the string argument as an unsigned integer similar to `Long.parseLong(String, int)`.
`static UnsignedInteger`	`replaceIfNullOrEqual(UnsignedInteger value, UnsignedInteger checkValue, UnsignedInteger defaultValue)` Returns the given defaultValue, if the given value is either null or equals to the given checkValue.
`static UnsignedInteger`	`replaceIfNullOrZero(UnsignedInteger value, UnsignedInteger defaultValue)` Convenience method for `replaceIfNullOrEqual(UnsignedInteger, UnsignedInteger, UnsignedInteger)`, that uses `ZERO` for the checkValue.
`UnsignedInteger`	`subtract(int decrement)` Subtract a value from this value.
`UnsignedInteger`	`subtract(long decrement)` Subtract a value from this value.
`UnsignedInteger`	`subtract(UnsignedInteger decrement)` Subtract a value from this value.
`String`	`toHex()` Convert the value to a hexadecimal string.
`int`	`toIntBits()` toIntBits.
`String`	`toString()`
`static UnsignedInteger`	`valueOf(long value)` valueOf.
`static UnsignedInteger`	`valueOf(String string)` Parses `UnsignedInteger` from String.
`static UnsignedInteger`	`valueOf(String string, int radix)` Parses `UnsignedInteger` from String.
`static UnsignedInteger`	`valueOf(UnsignedByte value)` Returns `UnsignedInteger` equivalent of the same value as the given `UnsignedByte`.

Methods inherited from class java.lang.Number
shortValue

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

- Field Detail
  - L_MAX_VALUE
```
public static final long L_MAX_VALUE
```
    See Also:
    
    Constant Field Values
  - L_MIN_VALUE
```
public static final long L_MIN_VALUE
```
    See Also:
    
    Constant Field Values
  - MAX_VALUE
```
public static final UnsignedInteger MAX_VALUE
```
  - MIN_VALUE
```
public static final UnsignedInteger MIN_VALUE
```
  - ZERO
```
public static final UnsignedInteger ZERO
```
  - ONE
```
public static final UnsignedInteger ONE
```
  - EMPTY_ARRAY
```
public static final UnsignedInteger[] EMPTY_ARRAY
```
- Constructor Detail
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger()
```
    Deprecated. use ZERO instead.
    
    Constructor for UnsignedInteger.
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger(int value)
                             throws IllegalArgumentException
```
    Deprecated. use valueOf(long) instead.
    
    Constructor for UnsignedInteger.
    
    Parameters:
    
    value - a int.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger(long value)
                             throws IllegalArgumentException
```
    Deprecated. valueOf(long) instead.
    
    Constructor for UnsignedInteger.
    
    Parameters:
    
    value - a long.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger(String value)
                             throws IllegalArgumentException
```
    Deprecated. use valueOf(String) instead.
    
    Constructor for UnsignedInteger.
    
    Parameters:
    
    value - a String object.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger(UnsignedByte value)
```
    Deprecated. use valueOf(UnsignedByte) instead.
    
    Constructor for UnsignedInteger.
    
    Parameters:
    
    value - a UnsignedByte object.
  - UnsignedInteger
```
@Deprecated
public UnsignedInteger(UnsignedInteger value)
```
    Deprecated. should not be used. Use the given value directly as UnsignedInteger.
    
    Constructor for UnsignedInteger.
    
    Parameters:
    
    value - a UnsignedInteger object.
- Method Detail
  - arrayOf
```
public static UnsignedInteger[] arrayOf()
```
    Returns an empty UnsignedInteger array.
  - arrayOf
```
public static UnsignedInteger[] arrayOf(long... elements)
```
    Returns an UnsignedInteger array with the given elements. Each element is parsed with valueOf(long). If given null array for elements returns null.
  - arrayOf
```
public static UnsignedInteger[] arrayOf(String... elements)
```
    Returns an UnsignedInteger array with the given elements. Each element is parsed with valueOf(String). If given null array for elements returns null.
  - clamp
```
public static UnsignedInteger clamp(UnsignedInteger value,
                                    UnsignedInteger min,
                                    UnsignedInteger max)
```
    Clamps the given value to fit between min and max. Any given nulls are treated as ZERO.
  - getFromBits
```
public static UnsignedInteger getFromBits(int value)
```
    getFromBits.
    
    Parameters:
    
    value - a int.
    
    Returns:
    
    a UnsignedInteger object.
  - max
```
public static UnsignedInteger max(UnsignedInteger v0,
                                  UnsignedInteger v1)
```
    max.
    
    Parameters:
    
    v0 - a UnsignedInteger object.
    
    v1 - a UnsignedInteger object.
    
    Returns:
    
    a UnsignedInteger object.
  - min
```
public static UnsignedInteger min(UnsignedInteger v0,
                                  UnsignedInteger v1)
```
    min.
    
    Parameters:
    
    v0 - a UnsignedInteger object.
    
    v1 - a UnsignedInteger object.
    
    Returns:
    
    a UnsignedInteger object.
  - parseUnsignedInteger
```
public static UnsignedInteger parseUnsignedInteger(String string)
                                            throws NumberFormatException,
                                                   IllegalArgumentException
```
    Parse an UnsignedInteger value from a string.
    
    Parameters:
    
    string - the string to parse, assumed to contain a positive Long value
    
    Returns:
    
    the respective UnsignedInteger
    
    Throws:
    
    NumberFormatException - if the string cannot be parsed into a Long value
    
    IllegalArgumentException - if the parsed value does not fit in the range of UnsignedInteger
  - parseUnsignedInteger
```
public static UnsignedInteger parseUnsignedInteger(String string,
                                                   int radix)
                                            throws NumberFormatException,
                                                   IllegalArgumentException
```
    Parses the string argument as an unsigned integer similar to Long.parseLong(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 UnsignedInteger
    
    Throws:
    
    NumberFormatException - if the string cannot be parsed into a Long value using the radix
    
    IllegalArgumentException - if the parsed value does not fit in the range of UnsignedInteger
  - replaceIfNullOrEqual
```
public static UnsignedInteger replaceIfNullOrEqual(UnsignedInteger value,
                                                   UnsignedInteger checkValue,
                                                   UnsignedInteger defaultValue)
```
    Returns the given defaultValue, if the given value is either null or equals to the given checkValue. Otherwise returns the given value.
  - replaceIfNullOrZero
```
public static UnsignedInteger replaceIfNullOrZero(UnsignedInteger value,
                                                  UnsignedInteger defaultValue)
```
    Convenience method for replaceIfNullOrEqual(UnsignedInteger, UnsignedInteger, UnsignedInteger), that uses ZERO for the checkValue. Returns the given defaultValue, if the given value is either null or .
  - valueOf
```
public static UnsignedInteger valueOf(long value)
```
    valueOf.
    
    Parameters:
    
    value - a long.
    
    Returns:
    
    a UnsignedInteger object.
  - valueOf
```
public static UnsignedInteger valueOf(String string)
```
    Parses UnsignedInteger from String. Behaves same as parseUnsignedInteger(String).
  - valueOf
```
public static UnsignedInteger valueOf(String string,
                                      int radix)
```
    Parses UnsignedInteger from String. Behaves same as parseUnsignedInteger(String, int).
  - valueOf
```
public static UnsignedInteger valueOf(UnsignedByte value)
```
    Returns UnsignedInteger equivalent of the same value as the given UnsignedByte.
  - add
```
public UnsignedInteger add(int 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 UnsignedInteger, increased by increment from this one.
  - add
```
public UnsignedInteger 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 UnsignedInteger, increased by increment from this one.
  - add
```
public UnsignedInteger add(UnsignedInteger 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 UnsignedInteger, increased by increment from this one.
  - and
```
public UnsignedInteger and(int value)
```
    and.
    
    Parameters:
    
    value - a int.
    
    Returns:
    
    a UnsignedInteger object.
  - and
```
public UnsignedInteger and(long value)
```
    and.
    
    Parameters:
    
    value - a long.
    
    Returns:
    
    a UnsignedInteger object.
  - and
```
public UnsignedInteger and(UnsignedInteger value)
```
    and.
    
    Parameters:
    
    value - a UnsignedInteger object.
    
    Returns:
    
    a UnsignedInteger object.
  - byteValue
```
public byte byteValue()
```
    Overrides:
    
    byteValue in class Number
  - compareTo
```
public int compareTo(Number other)
```
    Specified by:
    
    compareTo in interface Comparable<Number>
  - dec
```
public UnsignedInteger dec()
```
    Decrease the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedInteger, decreased by 1 from this one.
    
    Throws:
    
    IllegalArgumentException - if the value was 0 before the call
  - decOrWrap
```
public UnsignedInteger decOrWrap()
```
    If equals MIN_VALUE, returns MAX_VALUE, otherwise return value - 1.
  - decOrWrapTo
```
public UnsignedInteger decOrWrapTo(UnsignedInteger 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
  - getValue
```
public long getValue()
```
    Getter for the field value.
    
    Returns:
    
    a long.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - inc
```
public UnsignedInteger inc()
```
    Increase the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedInteger, increased by 1 from this one.
  - incOrWrap
```
public UnsignedInteger incOrWrap()
```
    If equals MAX_VALUE, returns MIN_VALUE, otherwise return value + 1.
  - incOrWrapTo
```
public UnsignedInteger incOrWrapTo(UnsignedInteger 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
  - or
```
public UnsignedInteger or(int value)
```
    or.
    
    Parameters:
    
    value - a int.
    
    Returns:
    
    a UnsignedInteger object.
  - or
```
public UnsignedInteger or(long value)
```
    or.
    
    Parameters:
    
    value - a long.
    
    Returns:
    
    a UnsignedInteger object.
  - or
```
public UnsignedInteger or(UnsignedInteger value)
```
    or.
    
    Parameters:
    
    value - a UnsignedInteger object.
    
    Returns:
    
    a UnsignedInteger object.
  - subtract
```
public UnsignedInteger subtract(int 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 UnsignedInteger, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - subtract
```
public UnsignedInteger 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 UnsignedInteger, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - subtract
```
public UnsignedInteger subtract(UnsignedInteger 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 UnsignedInteger, 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(int) to do the conversion.
  - toIntBits
```
public int toIntBits()
```
    toIntBits.
    
    Returns:
    
    a int.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UnsignedInteger

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

L_MAX_VALUE

L_MIN_VALUE

MAX_VALUE

MIN_VALUE

ZERO

ONE

EMPTY_ARRAY

Constructor Detail

UnsignedInteger

UnsignedInteger

UnsignedInteger

UnsignedInteger

UnsignedInteger

UnsignedInteger

Method Detail

arrayOf

arrayOf

arrayOf

clamp

getFromBits

max

min

parseUnsignedInteger

parseUnsignedInteger

replaceIfNullOrEqual

replaceIfNullOrZero

valueOf

valueOf

valueOf

valueOf

add

add

add

and

and

and

byteValue

compareTo

dec

decOrWrap

decOrWrapTo

doubleValue

equals

floatValue

getValue

hashCode

inc

incOrWrap

incOrWrapTo

intValue

isBitSet

longValue

or

or

or

subtract

subtract

subtract

toHex

toIntBits

toString