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

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

All Implemented Interfaces:

BitField, Serializable, Comparable<UnsignedByte>
```
public final class UnsignedByte
extends Number
implements Comparable<UnsignedByte>, BitField
```
UnsignedByte represents an integer number value between 0 .. and 0xFF (255). This class is immutable, instances should be constructed with the static factory methods. This class is mapped to OPC UA DataType Byte (Note, OPC UA DataType Byte means unsigned byte and OPC UA DataType SByte means signed byte, which is mapped to Byte).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static UnsignedByte[]`	`EMPTY_ARRAY`
`static NodeId`	`ID` Deprecated. use `Identifiers.Byte` instead.
`static long`	`L_MAX_VALUE`
`static long`	`L_MIN_VALUE`
`static UnsignedByte`	`MAX_VALUE`
`static UnsignedByte`	`MIN_VALUE`
`static UnsignedByte`	`ONE`
`static UnsignedByte`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`UnsignedByte()` Deprecated. use `ZERO`
`UnsignedByte(byte value)` Deprecated. use `valueOf(int)`
`UnsignedByte(int value)` Deprecated. use `valueOf(int)` instead.
`UnsignedByte(long value)` Deprecated. use `valueOf(long)` instead.
`UnsignedByte(String valueString)` Deprecated. use `valueOf(String)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnsignedByte`	`add(int increment)` Add a value.
`UnsignedByte`	`add(UnsignedByte increment)` Add a value.
`static UnsignedByte[]`	`arrayOf()` Returns an empty UnsignedByte array.
`static UnsignedByte[]`	`arrayOf(long... elements)` Returns an UnsignedByte array with the given elements.
`static UnsignedByte[]`	`arrayOf(String... elements)` Returns an UnsignedByte array with the given elements.
`byte`	`byteValue()`
`int`	`compareTo(UnsignedByte other)` compareTo.
`UnsignedByte`	`dec()` Decrease the value by one.
`UnsignedByte`	`decOrWrap()` If equals `MIN_VALUE`, returns `MAX_VALUE`, otherwise return value - 1.
`UnsignedByte`	`decOrWrapTo(UnsignedByte target)` If equals `MIN_VALUE`, returns the given target, otherwise return value - 1.
`double`	`doubleValue()`
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`static UnsignedByte`	`getFromBits(byte value)` getFromBits.
`int`	`getValue()` Getter for the field `value`.
`int`	`hashCode()`
`UnsignedByte`	`inc()` Increase the value by one.
`UnsignedByte`	`incOrWrap()` If equals `MAX_VALUE`, returns `MIN_VALUE`, otherwise return value + 1.
`UnsignedByte`	`incOrWrapTo(UnsignedByte 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 UnsignedByte`	`max(UnsignedByte v0, UnsignedByte v1)` max.
`static UnsignedByte`	`min(UnsignedByte v0, UnsignedByte v1)` min.
`static UnsignedByte`	`parseUnsignedByte(String str)` Parse an UnsignedByte value from a string.
`static UnsignedByte`	`parseUnsignedByte(String str, int radix)` Parses the string argument as an unsigned byte similar to `Integer.parseInt(String, int)`.
`UnsignedByte`	`subtract(int decrement)` Subtract a value from this value.
`UnsignedByte`	`subtract(UnsignedByte decrement)` Subtract a value from this value.
`byte`	`toByteBits()` toByteBits.
`String`	`toString()`
`static UnsignedByte`	`valueOf(int value)` valueOf.
`static UnsignedByte`	`valueOf(long value)`
`static UnsignedByte`	`valueOf(String str)` Parses `UnsignedByte` from String.
`static UnsignedByte`	`valueOf(String str, int radix)` Parses `UnsignedByte` from String.

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
  - ID
```
@Deprecated
public static final NodeId ID
```
    Deprecated. use Identifiers.Byte instead.
    
    The NodeId for the DataType node Byte in the UA AddressSpace.
  - 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 UnsignedByte MAX_VALUE
```
  - MIN_VALUE
```
public static final UnsignedByte MIN_VALUE
```
  - ZERO
```
public static final UnsignedByte ZERO
```
  - ONE
```
public static final UnsignedByte ONE
```
  - EMPTY_ARRAY
```
public static final UnsignedByte[] EMPTY_ARRAY
```
- Constructor Detail
  - UnsignedByte
```
@Deprecated
public UnsignedByte()
```
    Deprecated. use ZERO
    
    Constructor for UnsignedByte.
  - UnsignedByte
```
@Deprecated
public UnsignedByte(byte value)
                          throws IllegalArgumentException
```
    Deprecated. use valueOf(int)
    
    Constructor for UnsignedByte.
    
    Parameters:
    
    value - a byte.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedByte
```
@Deprecated
public UnsignedByte(int value)
                          throws IllegalArgumentException
```
    Deprecated. use valueOf(int) instead.
    
    Constructor for UnsignedByte.
    
    Parameters:
    
    value - a int.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedByte
```
@Deprecated
public UnsignedByte(long value)
                          throws IllegalArgumentException
```
    Deprecated. use valueOf(long) instead.
    
    Constructor for UnsignedByte.
    
    Parameters:
    
    value - a long.
    
    Throws:
    
    IllegalArgumentException - if any.
  - UnsignedByte
```
@Deprecated
public UnsignedByte(String valueString)
                          throws IllegalArgumentException
```
    Deprecated. use valueOf(String) instead.
    
    Constructor for UnsignedByte.
    
    Parameters:
    
    valueString - a String object.
    
    Throws:
    
    IllegalArgumentException - if any.
- Method Detail
  - arrayOf
```
public static UnsignedByte[] arrayOf()
```
    Returns an empty UnsignedByte array.
  - arrayOf
```
public static UnsignedByte[] arrayOf(long... elements)
```
    Returns an UnsignedByte array with the given elements. Each element is parsed with valueOf(long). If given null array for elements returns null.
  - arrayOf
```
public static UnsignedByte[] arrayOf(String... elements)
```
    Returns an UnsignedByte array with the given elements. Each element is parsed with valueOf(String). If given null array for elements returns null.
  - getFromBits
```
public static UnsignedByte getFromBits(byte value)
```
    getFromBits.
    
    Parameters:
    
    value - a byte.
    
    Returns:
    
    a UnsignedByte object.
  - max
```
public static UnsignedByte max(UnsignedByte v0,
                               UnsignedByte v1)
```
    max.
    
    Parameters:
    
    v0 - a UnsignedByte object.
    
    v1 - a UnsignedByte object.
    
    Returns:
    
    a UnsignedByte object.
  - min
```
public static UnsignedByte min(UnsignedByte v0,
                               UnsignedByte v1)
```
    min.
    
    Parameters:
    
    v0 - a UnsignedByte object.
    
    v1 - a UnsignedByte object.
    
    Returns:
    
    a UnsignedByte object.
  - parseUnsignedByte
```
public static UnsignedByte parseUnsignedByte(String str)
```
    Parse an UnsignedByte value from a string.
    
    Parameters:
    
    str - the string to parse, assumed to contain a positive Integer value
    
    Returns:
    
    the respective UnsignedInteger
  - parseUnsignedByte
```
public static UnsignedByte parseUnsignedByte(String str,
                                             int radix)
```
    Parses the string argument as an unsigned byte similar to Integer.parseInt(String, int).
    
    Parameters:
    
    str - the string to parse, assumed to contain a positive Integer value
    
    radix - the radix to be used while parsing s.
    
    Returns:
    
    the respective UnsignedInteger
  - valueOf
```
public static UnsignedByte valueOf(int value)
```
    valueOf.
    
    Parameters:
    
    value - a int.
    
    Returns:
    
    a UnsignedByte object.
  - valueOf
```
public static UnsignedByte valueOf(long value)
```
  - valueOf
```
public static UnsignedByte valueOf(String str)
```
    Parses UnsignedByte from String. Behaves the same as parseUnsignedByte(String).
  - valueOf
```
public static UnsignedByte valueOf(String str,
                                   int radix)
```
    Parses UnsignedByte from String. Behaves the same as parseUnsignedByte(String, int).
  - add
```
public UnsignedByte 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 UnsignedByte, increased by increment from this one.
  - add
```
public UnsignedByte add(UnsignedByte 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 UnsignedByte, increased by increment from this one.
  - byteValue
```
public byte byteValue()
```
    Overrides:
    
    byteValue in class Number
  - compareTo
```
public int compareTo(UnsignedByte other)
```
    compareTo.
    
    Specified by:
    
    compareTo in interface Comparable<UnsignedByte>
    
    Parameters:
    
    other - a UnsignedByte object.
    
    Returns:
    
    a int.
  - dec
```
public UnsignedByte dec()
```
    Decrease the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedByte, decreased by 1 from this one.
    
    Throws:
    
    IllegalArgumentException - if the value was 0 before the call
  - decOrWrap
```
public UnsignedByte decOrWrap()
```
    If equals MIN_VALUE, returns MAX_VALUE, otherwise return value - 1.
  - decOrWrapTo
```
public UnsignedByte decOrWrapTo(UnsignedByte 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 int getValue()
```
    Getter for the field value.
    
    Returns:
    
    a int.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - inc
```
public UnsignedByte inc()
```
    Increase the value by one. Note that this object is not changed, but a new one is created.
    
    Returns:
    
    a new UnsignedByte, increased by 1 from this one.
  - incOrWrap
```
public UnsignedByte incOrWrap()
```
    If equals MAX_VALUE, returns MIN_VALUE, otherwise return value + 1.
  - incOrWrapTo
```
public UnsignedByte incOrWrapTo(UnsignedByte 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 UnsignedByte 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 UnsignedByte, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - subtract
```
public UnsignedByte subtract(UnsignedByte 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 UnsignedByte, decreased by decrement from this one.
    
    Throws:
    
    IllegalArgumentException - if the decrement is bigger than the current value
  - toByteBits
```
public byte toByteBits()
```
    toByteBits.
    
    Returns:
    
    a byte.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UnsignedByte

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ID

L_MAX_VALUE

L_MIN_VALUE

MAX_VALUE

MIN_VALUE

ZERO

ONE

EMPTY_ARRAY

Constructor Detail

UnsignedByte

UnsignedByte

UnsignedByte

UnsignedByte

UnsignedByte

Method Detail

arrayOf

arrayOf

arrayOf

getFromBits

max

min

parseUnsignedByte

parseUnsignedByte

valueOf

valueOf

valueOf

valueOf

add

add

byteValue

compareTo

dec

decOrWrap

decOrWrapTo

doubleValue

equals

floatValue

getValue

hashCode

inc

incOrWrap

incOrWrapTo

intValue

isBitSet

longValue

subtract

subtract

toByteBits

toString