BytesCommon (OpenHFT/Java-Lang/lang 6.1.4 API)

All Known Subinterfaces:

Bytes, ByteStringAppender, ByteStringParser, RandomDataInput, RandomDataOutput

All Known Implementing Classes:

AbstractBytes, ByteBufferBytes, DirectBytes, MultiStoreBytes, NativeBytes
```
public interface BytesCommon
```
Author:

peter.lawrey

Method Summary

Methods
Modifier and Type	Method and Description
`ByteOrder`	`byteOrder()`
`BytesMarshallerFactory`	`bytesMarshallerFactory()`
`long`	`capacity()`
`void`	`checkEndOfBuffer()`
`void`	`finish()` Mark the end of the message if writing and check we are at the end of the message if reading.
`InputStream`	`inputStream()`
`boolean`	`isFinished()`
`OutputStream`	`outputStream()`
`long`	`position()`
`void`	`position(long position)`
`long`	`remaining()`
`void`	`reset()` Start again, unfinished, position() == 0
`void`	`write(BytesCommon bytes, long position, long length)` Copy from one Bytes to another, moves the position by length

- Method Detail
  - position
```
long position()
```
    Returns:
    the offset read/written so far
  - position
```
void position(long position)
```
    Parameters:
    position - to skip to
  - capacity
```
long capacity()
```
    Returns:
    space available
  - remaining
```
long remaining()
```
    Returns:
    space remaining in bytes
  - finish
```
void finish()
            throws IndexOutOfBoundsException
```
    Mark the end of the message if writing and check we are at the end of the message if reading.
    
    Throws:
    
    IndexOutOfBoundsException - if too much data was written.
  - isFinished
```
boolean isFinished()
```
    Returns:
    has finish been called.
  - reset
```
void reset()
```
    Start again, unfinished, position() == 0
  - byteOrder
```
@NotNull
ByteOrder byteOrder()
```
    Returns:
    Byte order for reading binary
  - inputStream
```
@NotNull
InputStream inputStream()
```
    Returns:
    these Bytes as an InputStream
  - outputStream
```
@NotNull
OutputStream outputStream()
```
    Returns:
    these Bytes as an OutputStream
  - bytesMarshallerFactory
```
@NotNull
BytesMarshallerFactory bytesMarshallerFactory()
```
    Returns:
    the factory for marshallers.
  - checkEndOfBuffer
```
void checkEndOfBuffer()
                      throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException - if the bounds of the Bytes has been exceeded.
  - write
```
void write(BytesCommon bytes,
         long position,
         long length)
```
    Copy from one Bytes to another, moves the position by length
    
    Parameters:
    bytes - to copy
    position - to copy from
    length - to copy

Interface BytesCommon

Method Summary

Method Detail

position

position

capacity

remaining

finish

isFinished

reset

byteOrder

inputStream

outputStream

bytesMarshallerFactory

checkEndOfBuffer

write