BinaryStream (Ignite 2.17.0)

All Known Subinterfaces:

BinaryInputStream, BinaryOutputStream, PlatformInputStream, PlatformOutputStream

All Known Implementing Classes:

BinaryAbstractInputStream, BinaryAbstractOutputStream, BinaryAbstractStream, BinaryByteBufferInputStream, BinaryHeapInputStream, BinaryHeapOutputStream, BinaryOffheapInputStream, BinaryOffheapOutputStream, PlatformBigEndianInputStreamImpl, PlatformBigEndianOutputStreamImpl, PlatformInputStreamImpl, PlatformOutputStreamImpl
```
public interface BinaryStream
```
Binary stream.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`byte[]`	`array()`
`byte[]`	`arrayCopy()`
`int`	`capacity()`
`boolean`	`hasArray()`
`long`	`offheapPointer()`
`int`	`position()`
`void`	`position(int pos)`
`long`	`rawOffheapPointer()`

- Method Detail
  - position
```
int position()
```
    Returns:
    
    Position.
  - position
```
void position(int pos)
```
    Parameters:
    
    pos - Position.
  - array
```
byte[] array()
```
    Returns:
    
    Underlying array.
  - arrayCopy
```
byte[] arrayCopy()
```
    Returns:
    
    Copy of data in the stream.
  - offheapPointer
```
long offheapPointer()
```
    Returns:
    
    Offheap pointer if stream is offheap based and "forceHeap" flag is not set; otherwise 0.
  - rawOffheapPointer
```
long rawOffheapPointer()
```
    Returns:
    
    Offheap pointer if stream is offheap based; otherwise 0.
  - hasArray
```
boolean hasArray()
```
    Returns:
    
    True is stream is array based.
  - capacity
```
int capacity()
```
    Returns:
    
    Total capacity.