ByteArrayScanner (Wren:DS Server 4.0.0-M3 Documentation)

java.lang.Object
- org.opends.server.replication.protocol.ByteArrayScanner

```
public class ByteArrayScanner
extends Object
```
Byte array scanner class helps decode data from byte arrays received via messages over the replication protocol. Built on top of ByteSequenceReader, it isolates the latter against legacy type conversions from the replication protocol.

See Also:

ByteArrayBuilder class that encodes messages read with current class.

Constructor Summary

Constructors
Constructor and Description

ByteArrayScanner(byte[] bytes)
Builds a ByteArrayScanner object that will read from the supplied byte array.

Constructors
Constructor and Description
`ByteArrayScanner(byte[] bytes)` Builds a ByteArrayScanner object that will read from the supplied byte array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.forgerock.opendj.io.ASN1Reader`	`getASN1Reader()` Returns a new ASN1Reader that will read bytes from this ByteArrayScanner.
`boolean`	`isEmpty()` Returns whether the scanner has more bytes to consume.
`boolean`	`nextBoolean()` Reads the next boolean.
`byte`	`nextByte()` Reads the next byte.
`byte[]`	`nextByteArray(int length)` Return a new byte array containing the requested number of bytes.
`CSN`	`nextCSN()` Reads the next CSN.
`CSN`	`nextCSNUTF8()` Reads the next CSN that was encoded as a UTF8 string.
`org.forgerock.opendj.ldap.DN`	`nextDN()` Reads the next DN.
`int`	`nextInt()` Reads the next int.
`int`	`nextIntUTF8()` Reads the next int that was encoded as a UTF8 string.
`long`	`nextLong()` Reads the next long.
`long`	`nextLongUTF8()` Reads the next long that was encoded as a UTF8 string.
`ServerState`	`nextServerStateMustComeLast()` Reads the next ServerState.
`short`	`nextShort()` Reads the next short.
`String`	`nextString()` Reads the next UTF8-encoded string.
`<TCol extends Collection<String>> TCol`	`nextStrings(TCol output)` Reads the next UTF8-encoded strings in the provided collection.
`byte[]`	`remainingBytes()` Return a new byte array containing all remaining bytes in this ByteArrayScanner.
`byte[]`	`remainingBytesZeroTerminated()` Return a new byte array containing all remaining bytes in this ByteArrayScanner bar the last one which is a zero terminated byte (compatible with legacy code).
`void`	`skipZeroSeparator()` Skips the next byte and verifies it is effectively the zero separator.
`String`	`toString()`

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

- Constructor Detail
  - ByteArrayScanner
```
public ByteArrayScanner(byte[] bytes)
```
    Builds a ByteArrayScanner object that will read from the supplied byte array.
    
    Parameters:
    
    bytes - the byte array input that will be read from
- Method Detail
  - nextBoolean
```
public boolean nextBoolean()
                    throws DataFormatException
```
    Reads the next boolean.
    
    Returns:
    
    the next boolean
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextByte
```
public byte nextByte()
              throws DataFormatException
```
    Reads the next byte.
    
    Returns:
    
    the next byte
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextShort
```
public short nextShort()
                throws DataFormatException
```
    Reads the next short.
    
    Returns:
    
    the next short
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextInt
```
public int nextInt()
            throws DataFormatException
```
    Reads the next int.
    
    Returns:
    
    the next int
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextLong
```
public long nextLong()
              throws DataFormatException
```
    Reads the next long.
    
    Returns:
    
    the next long
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextIntUTF8
```
public int nextIntUTF8()
                throws DataFormatException
```
    Reads the next int that was encoded as a UTF8 string.
    
    Returns:
    
    the next int that was encoded as a UTF8 string.
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextLongUTF8
```
public long nextLongUTF8()
                  throws DataFormatException
```
    Reads the next long that was encoded as a UTF8 string.
    
    Returns:
    
    the next long that was encoded as a UTF8 string.
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextString
```
public String nextString()
                  throws DataFormatException
```
    Reads the next UTF8-encoded string.
    
    Returns:
    
    the next UTF8-encoded string or null if the string length is zero
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextStrings
```
public <TCol extends Collection<String>> TCol nextStrings(TCol output)
                                                   throws DataFormatException
```
    Reads the next UTF8-encoded strings in the provided collection.
    
    Type Parameters:
    
    TCol - the collection's concrete type
    
    Parameters:
    
    output - the collection where to add the next UTF8-encoded strings
    
    Returns:
    
    the provided collection where the next UTF8-encoded strings have been added.
    
    Throws:
    
    DataFormatException - if no more data can be read from the input
  - nextCSN
```
public CSN nextCSN()
            throws DataFormatException
```
    Reads the next CSN.
    
    Returns:
    
    the next CSN.
    
    Throws:
    
    DataFormatException - if CSN was incorrectly encoded or no more data can be read from the input
  - nextCSNUTF8
```
public CSN nextCSNUTF8()
                throws DataFormatException
```
    Reads the next CSN that was encoded as a UTF8 string.
    
    Returns:
    
    the next CSN that was encoded as a UTF8 string.
    
    Throws:
    
    DataFormatException - if legacy CSN was incorrectly encoded or no more data can be read from the input
  - nextDN
```
public org.forgerock.opendj.ldap.DN nextDN()
                                    throws DataFormatException
```
    Reads the next DN.
    
    Returns:
    
    the next DN.
    
    Throws:
    
    DataFormatException - if DN was incorrectly encoded or no more data can be read from the input
  - remainingBytes
```
public byte[] remainingBytes()
```
    Return a new byte array containing all remaining bytes in this ByteArrayScanner.
    
    Returns:
    
    new byte array containing all remaining bytes
  - remainingBytesZeroTerminated
```
public byte[] remainingBytesZeroTerminated()
```
    Return a new byte array containing all remaining bytes in this ByteArrayScanner bar the last one which is a zero terminated byte (compatible with legacy code).
    
    Returns:
    
    new byte array containing all remaining bytes bar the last one
  - nextByteArray
```
public byte[] nextByteArray(int length)
```
    Return a new byte array containing the requested number of bytes.
    
    Parameters:
    
    length - the number of bytes to be read and copied to the new byte array.
    
    Returns:
    
    new byte array containing the requested number of bytes.
  - nextServerStateMustComeLast
```
public ServerState nextServerStateMustComeLast()
                                        throws DataFormatException
```
    Reads the next ServerState.
    Caution: ServerState MUST be the last field (see ByteArrayBuilder.appendServerStateMustComeLast(ServerState) javadoc).
    Note: the super long method name it is intentional: nobody will want to use it, which is good because nobody should.
    
    Returns:
    
    the next ServerState.
    
    Throws:
    
    DataFormatException - if ServerState was incorrectly encoded or no more data can be read from the input
    
    See Also:
    
    ByteArrayBuilder.appendServerStateMustComeLast(ServerState)
  - skipZeroSeparator
```
public void skipZeroSeparator()
                       throws DataFormatException
```
    Skips the next byte and verifies it is effectively the zero separator.
    
    Throws:
    
    DataFormatException - if the next byte is not the zero separator.
  - getASN1Reader
```
public org.forgerock.opendj.io.ASN1Reader getASN1Reader()
```
    Returns a new ASN1Reader that will read bytes from this ByteArrayScanner.
    
    Returns:
    
    a new ASN1Reader that will read bytes from this ByteArrayScanner.
  - isEmpty
```
public boolean isEmpty()
```
    Returns whether the scanner has more bytes to consume.
    
    Returns:
    
    true if the scanner has more bytes to consume, false otherwise.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ByteArrayScanner

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteArrayScanner

Method Detail

nextBoolean

nextByte

nextShort

nextInt

nextLong

nextIntUTF8

nextLongUTF8

nextString

nextStrings

nextCSN

nextCSNUTF8

nextDN

remainingBytes

remainingBytesZeroTerminated

nextByteArray

nextServerStateMustComeLast

skipZeroSeparator

getASN1Reader

isEmpty

toString