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

java.lang.Object
- com.prosysopc.ua.stack.builtintypes.ByteString

All Implemented Interfaces:

BitField, Comparable<ByteString>
```
public final class ByteString
extends Object
implements Comparable<ByteString>, BitField
```
This primitive DataType specifies an immutable ByteString, similar as String but for bytes. Instances must be constructed via the static factory methods.

Field Summary

Fields
Modifier and Type Field and Description

static ByteString EMPTY
ByteString instance that models empty ByteString.

static ByteString[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static ByteString`	`EMPTY` ByteString instance that models empty ByteString.
`static ByteString[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteString`	`append(byte[] data)` Returns a ByteString where the given bytes are appended to this ByteString.
`ByteString`	`append(ByteString data)` Returns a ByteString where the given bytes are appended to this ByteString.
`static byte[]`	`asByteArray(ByteString byteString)` A null-safe way to convert ByteString to byte[].
`int`	`compareTo(ByteString other)`
`void`	`copyTo(ByteArrayOutputStream stream)` Copies the contents of this ByteString to the given stream.
`void`	`copyTo(ByteArrayOutputStream stream, int offset, int length)` Same as `copyTo(ByteArrayOutputStream)`, but allows specifying part of this ByteString to be put to the stream.
`void`	`copyTo(IBinaryWriteable stream)` Same as `copyTo(ByteArrayOutputStream)`, but for `IBinaryWriteable`, but needs handling of `IOException`.
`void`	`copyTo(IBinaryWriteable stream, int offset, int length)` Same as `copyTo(ByteArrayOutputStream, int, int)`, but for `IBinaryWriteable`, but needs handling of `IOException`.
`void`	`copyTo(OutputStream stream)` Same as `copyTo(ByteArrayOutputStream)`, but works for all `OutputStream`, but needs handling of `IOException`.
`void`	`copyTo(OutputStream stream, int offset, int length)` Same as `copyTo(ByteArrayOutputStream, int, int)`, but works for all `OutputStream`, but needs handling of `IOException`.
`boolean`	`equals(Object obj)`
`static ByteString`	`from(ByteArrayOutputStream stream)` Returns a `ByteString` whose value matches as if `ByteArrayOutputStream.toByteArray()` was called for the given stream.
`static ByteString`	`fromBitSet(BitSet set)` Creates a ByteString from a `BitSet`.
`static ByteString`	`fromBitSet(BitSet set, int minimumLengthInBytes)` Same as `fromBitSet(BitSet)`, but allows specifying a minimum length.
`static ByteString`	`fromHex(String hex)` Creates a ByteString from a hex string.
`static ByteString`	`fromLong(long value)` Creates a `ByteString` where the given Long (OPC UA Int64) is OPC UA Binary encoded (i.e.
`static ByteString`	`fromUUID(UUID guid)` Creates a `ByteString` where the given UUID is OPC UA Binary encoded (i.e.
`int`	`getLength()` Return the length of this ByteString.
`byte[]`	`getValue()` Get a copy of the value of this ByteString as byte array.
`int`	`hashCode()`
`boolean`	`isBitSet(int position)` Is bit set in position.
`static boolean`	`isNullOrEmpty(ByteString data)` Returns true if given data is null or `EMPTY` , false otherwise.
`BitSet`	`toBitSet()` Returns a `BitSet` with the copy of the data of this `ByteString`.
`String`	`toHex()` Calls `CryptoUtil.toHex(byte[], int, boolean)` with the value of this ByteString without length prefix and 0 (no limit) for bytesPerRow.
`String`	`toString()`
`static ByteString`	`valueOf(byte... byteArray)` Creates a ByteString from a byte array (will copy).

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

- Field Detail
  - EMPTY
```
public static final ByteString EMPTY
```
    ByteString instance that models empty ByteString.
  - EMPTY_ARRAY
```
public static final ByteString[] EMPTY_ARRAY
```
- Method Detail
  - asByteArray
```
public static byte[] asByteArray(ByteString byteString)
```
    A null-safe way to convert ByteString to byte[]. The given array is copied for value.
    
    Parameters:
    
    byteString - a ByteString or null
    
    Returns:
    
    byte[] or null if given null
  - from
```
public static ByteString from(ByteArrayOutputStream stream)
```
    Returns a ByteString whose value matches as if ByteArrayOutputStream.toByteArray() was called for the given stream. Calling this method avoids making an extra copy of the array. IMPORTANT! The given stream shall be as such, that the byte[] returned by it's ByteArrayOutputStream.toByteArray() wont be modified after returning. Returns null if given null stream.
  - fromBitSet
```
public static ByteString fromBitSet(BitSet set)
```
    Creates a ByteString from a BitSet. This is the same as calling ByteString.valueOf(set.toByteArray()). Returns null if given null. NOTE! that BitSet only stores the info about the bits that are set, thus giving a BitSet from toBitSet() to this method might not result in the same object, depending on the position of set bits.
  - fromBitSet
```
public static ByteString fromBitSet(BitSet set,
                                    int minimumLengthInBytes)
```
    Same as fromBitSet(BitSet), but allows specifying a minimum length. If the result of fromBitSet(BitSet) would produce a ByteString less than the given minimum, the ByteString is padded with zero bytes until getLength() is equal to the given minimum.
  - fromHex
```
public static ByteString fromHex(String hex)
```
    Creates a ByteString from a hex string.
    
    Parameters:
    
    hex - a String object
    
    Returns:
    
    new ByteString
  - fromLong
```
public static ByteString fromLong(long value)
```
    Creates a ByteString where the given Long (OPC UA Int64) is OPC UA Binary encoded (i.e. the same as-if IEncoder.putInt64(String, Long) would have been used) with the ByteString.
  - fromUUID
```
public static ByteString fromUUID(UUID guid)
```
    Creates a ByteString where the given UUID is OPC UA Binary encoded (i.e. the same as-if IEncoder.putGuid(String, UUID) would have been used) with the ByteString.
  - isNullOrEmpty
```
public static boolean isNullOrEmpty(ByteString data)
```
    Returns true if given data is null or EMPTY , false otherwise.
  - valueOf
```
public static ByteString valueOf(byte... byteArray)
```
    Creates a ByteString from a byte array (will copy).
    
    Parameters:
    
    byteArray - the byte array
    
    Returns:
    
    new ByteString or null if given null array
  - append
```
public ByteString append(byte[] data)
```
    Returns a ByteString where the given bytes are appended to this ByteString. If null is given, will return this ByteString.
  - append
```
public ByteString append(ByteString data)
```
    Returns a ByteString where the given bytes are appended to this ByteString. If null is given, will return this ByteString.
  - compareTo
```
public int compareTo(ByteString other)
```
    Specified by:
    
    compareTo in interface Comparable<ByteString>
  - copyTo
```
public void copyTo(ByteArrayOutputStream stream)
```
    Copies the contents of this ByteString to the given stream. IMPORTANT! The given stream shall copy the contents, otherwise results are undefined.
    
    Parameters:
    
    stream - the stream to copy to, not null
  - copyTo
```
public void copyTo(ByteArrayOutputStream stream,
                   int offset,
                   int length)
```
    Same as copyTo(ByteArrayOutputStream), but allows specifying part of this ByteString to be put to the stream.
    
    Parameters:
    
    stream - the stream to copy to, not null
    
    offset - starting index
    
    length - number of bytes to copy from the offset index.
    
    Throws:
    
    IndexOutOfBoundsException - if invalid offsets or lengths are given
  - copyTo
```
public void copyTo(IBinaryWriteable stream)
            throws IOException
```
    Same as copyTo(ByteArrayOutputStream), but for IBinaryWriteable, but needs handling of IOException.
    
    Throws:
    
    IOException
  - copyTo
```
public void copyTo(IBinaryWriteable stream,
                   int offset,
                   int length)
            throws IOException
```
    Same as copyTo(ByteArrayOutputStream, int, int), but for IBinaryWriteable, but needs handling of IOException.
    
    Throws:
    
    IOException
  - copyTo
```
public void copyTo(OutputStream stream)
            throws IOException
```
    Same as copyTo(ByteArrayOutputStream), but works for all OutputStream, but needs handling of IOException.
    
    Throws:
    
    IOException
  - copyTo
```
public void copyTo(OutputStream stream,
                   int offset,
                   int length)
            throws IOException
```
    Same as copyTo(ByteArrayOutputStream, int, int), but works for all OutputStream, but needs handling of IOException.
    
    Throws:
    
    IOException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getLength
```
public int getLength()
```
    Return the length of this ByteString.
  - getValue
```
public byte[] getValue()
```
    Get a copy of the value of this ByteString as byte array.
    
    Returns:
    
    copy of the value as byte array. Not null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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
  - toBitSet
```
public BitSet toBitSet()
```
    Returns a BitSet with the copy of the data of this ByteString. Modifying the BitSet wont change this immutable ByteString. NOTE! that BitSet only stores the info about the bits that are set, thus giving this BitSet back in fromBitSet(BitSet) can cause a different getLength() to this object depending on the positions of set bits.
  - toHex
```
public String toHex()
```
    Calls CryptoUtil.toHex(byte[], int, boolean) with the value of this ByteString without length prefix and 0 (no limit) for bytesPerRow.
    Note that toString() calls CryptoUtil#toHex with length prefix.
    
    Returns:
    
    a String object.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ByteString

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

EMPTY_ARRAY

Method Detail

asByteArray

from

fromBitSet

fromBitSet

fromHex

fromLong

fromUUID

isNullOrEmpty

valueOf

append

append

compareTo

copyTo

copyTo

copyTo

copyTo

copyTo

copyTo

equals

getLength

getValue

hashCode

isBitSet

toBitSet

toHex

toString