BytesBuffer (hugegraph-client 1.0.0 API)

java.lang.Object
- java.io.OutputStream
- - org.apache.hugegraph.serializer.direct.util.BytesBuffer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable
```
public final class BytesBuffer
extends OutputStream
```
class BytesBuffer is an util for read/write binary

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BIG_ID_LEN_MAX`
`static int`	`BLOB_LEN`
`static long`	`BLOB_LEN_MAX`
`static int`	`BUF_EDGE_ID`
`static int`	`BUF_PROPERTY`
`static int`	`BYTE_LEN`
`static int`	`CHAR_LEN`
`static int`	`DEFAULT_CAPACITY`
`static int`	`DOUBLE_LEN`
`static int`	`FLOAT_LEN`
`static int`	`ID_LEN_MASK`
`static int`	`ID_LEN_MAX`
`static int`	`INDEX_HASH_ID_THRESHOLD`
`static int`	`INT_LEN`
`static int`	`LONG_LEN`
`static int`	`MAX_BUFFER_CAPACITY`
`static int`	`SHORT_LEN`
`static byte`	`STRING_ENDING_BYTE`
`static byte`	`STRING_ENDING_BYTE_FF`
`static int`	`STRING_LEN_MAX`
`static int`	`UINT16_MAX`
`static long`	`UINT32_MAX`
`static int`	`UINT8_MAX`

Constructor Summary

Constructors
Constructor and Description

BytesBuffer()

BytesBuffer(ByteBuffer buffer)

BytesBuffer(int capacity)

Constructors
Constructor and Description
`BytesBuffer()`
`BytesBuffer(ByteBuffer buffer)`
`BytesBuffer(int capacity)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BytesBuffer`	`allocate(int capacity)`
`byte[]`	`array()`
`ByteBuffer`	`asByteBuffer()`
`byte[]`	`bytes()`
`BytesBuffer`	`copyFrom(BytesBuffer other)`
`BytesBuffer`	`forReadAll()`
`BytesBuffer`	`forReadWritten()`
`byte`	`peek()`
`byte`	`peekLast()`
`int`	`position()`
`byte`	`read()`
`byte[]`	`read(int length)`
`byte[]`	`readBigBytes()`
`boolean`	`readBoolean()`
`byte[]`	`readBytes()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`int`	`readInt()`
`long`	`readLong()`
`short`	`readShort()`
`String`	`readString()`
`String`	`readStringFromRemaining()`
`String`	`readStringWithEnding()`
`int`	`readUInt16()`
`long`	`readUInt32()`
`int`	`readUInt8()`
`int`	`readVInt()`
`long`	`readVLong()`
`int`	`remaining()`
`static BytesBuffer`	`wrap(byte[] array)`
`static BytesBuffer`	`wrap(byte[] array, int offset, int length)`
`static BytesBuffer`	`wrap(ByteBuffer buffer)`
`BytesBuffer`	`write(byte val)`
`void`	`write(byte[] val)`
`void`	`write(byte[] val, int offset, int length)`
`void`	`write(int val)`
`BytesBuffer`	`writeBigBytes(byte[] bytes)`
`BytesBuffer`	`writeBoolean(boolean val)`
`BytesBuffer`	`writeBytes(byte[] bytes)`
`BytesBuffer`	`writeChar(char val)`
`BytesBuffer`	`writeDouble(double val)`
`BytesBuffer`	`writeFloat(float val)`
`BytesBuffer`	`writeId(Id id)`
`BytesBuffer`	`writeId(Id id, boolean big)`
`BytesBuffer`	`writeIndexId(Id id, HugeType type)`
`BytesBuffer`	`writeIndexId(Id id, HugeType type, boolean withEnding)`
`BytesBuffer`	`writeInt(int val)`
`BytesBuffer`	`writeLong(long val)`
`void`	`writeProperty(DataType dataType, Object value)`
`BytesBuffer`	`writeShort(short val)`
`BytesBuffer`	`writeString(String val)`
`BytesBuffer`	`writeStringRaw(String val)`
`BytesBuffer`	`writeStringToRemaining(String value)`
`BytesBuffer`	`writeStringWithEnding(String value)`
`BytesBuffer`	`writeUInt16(int val)`
`BytesBuffer`	`writeUInt32(long val)`
`BytesBuffer`	`writeUInt8(int val)`
`BytesBuffer`	`writeVInt(int value)`
`BytesBuffer`	`writeVLong(long value)`

Methods inherited from class java.io.OutputStream
close, flush

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

Field Detail
- BYTE_LEN
```
public static final int BYTE_LEN
```
  See Also:
  
  Constant Field Values
- SHORT_LEN
```
public static final int SHORT_LEN
```
  See Also:
  
  Constant Field Values
- INT_LEN
```
public static final int INT_LEN
```
  See Also:
  
  Constant Field Values
- LONG_LEN
```
public static final int LONG_LEN
```
  See Also:
  
  Constant Field Values
- CHAR_LEN
```
public static final int CHAR_LEN
```
  See Also:
  
  Constant Field Values
- FLOAT_LEN
```
public static final int FLOAT_LEN
```
  See Also:
  
  Constant Field Values
- DOUBLE_LEN
```
public static final int DOUBLE_LEN
```
  See Also:
  
  Constant Field Values
- BLOB_LEN
```
public static final int BLOB_LEN
```
  See Also:
  
  Constant Field Values
- UINT8_MAX
```
public static final int UINT8_MAX
```
  See Also:
  
  Constant Field Values
- UINT16_MAX
```
public static final int UINT16_MAX
```
  See Also:
  
  Constant Field Values
- UINT32_MAX
```
public static final long UINT32_MAX
```
  See Also:
  
  Constant Field Values
- ID_LEN_MASK
```
public static final int ID_LEN_MASK
```
  See Also:
  
  Constant Field Values
- ID_LEN_MAX
```
public static final int ID_LEN_MAX
```
  See Also:
  
  Constant Field Values
- BIG_ID_LEN_MAX
```
public static final int BIG_ID_LEN_MAX
```
  See Also:
  
  Constant Field Values
- STRING_ENDING_BYTE
```
public static final byte STRING_ENDING_BYTE
```
  See Also:
  
  Constant Field Values
- STRING_ENDING_BYTE_FF
```
public static final byte STRING_ENDING_BYTE_FF
```
  See Also:
  
  Constant Field Values
- STRING_LEN_MAX
```
public static final int STRING_LEN_MAX
```
  See Also:
  
  Constant Field Values
- BLOB_LEN_MAX
```
public static final long BLOB_LEN_MAX
```
  See Also:
  
  Constant Field Values
- INDEX_HASH_ID_THRESHOLD
```
public static final int INDEX_HASH_ID_THRESHOLD
```
  See Also:
  
  Constant Field Values
- DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
  See Also:
  
  Constant Field Values
- MAX_BUFFER_CAPACITY
```
public static final int MAX_BUFFER_CAPACITY
```
  See Also:
  
  Constant Field Values
- BUF_EDGE_ID
```
public static final int BUF_EDGE_ID
```
  See Also:
  
  Constant Field Values
- BUF_PROPERTY
```
public static final int BUF_PROPERTY
```
  See Also:
  
  Constant Field Values

Constructor Detail

BytesBuffer
```
public BytesBuffer()
```

BytesBuffer
```
public BytesBuffer(int capacity)
```

BytesBuffer
```
public BytesBuffer(ByteBuffer buffer)
```

Method Detail

allocate

public static BytesBuffer allocate(int capacity)

wrap

public static BytesBuffer wrap(ByteBuffer buffer)

wrap

public static BytesBuffer wrap(byte[] array)

wrap

public static BytesBuffer wrap(byte[] array,
                               int offset,
                               int length)

asByteBuffer
```
public ByteBuffer asByteBuffer()
```

forReadWritten
```
public BytesBuffer forReadWritten()
```

forReadAll
```
public BytesBuffer forReadAll()
```

array
```
public byte[] array()
```

bytes
```
public byte[] bytes()
```

position
```
public int position()
```

copyFrom

public BytesBuffer copyFrom(BytesBuffer other)

remaining
```
public int remaining()
```

write
```
public BytesBuffer write(byte val)
```

write
```
public void write(int val)
```
Specified by:

write in class OutputStream

write
```
public void write(byte[] val)
```
Overrides:

write in class OutputStream

write

public void write(byte[] val,
                  int offset,
                  int length)

Overrides:: write in class OutputStream

writeBoolean

public BytesBuffer writeBoolean(boolean val)

writeChar

public BytesBuffer writeChar(char val)

writeShort

public BytesBuffer writeShort(short val)

writeInt
```
public BytesBuffer writeInt(int val)
```

writeLong

public BytesBuffer writeLong(long val)

writeFloat

public BytesBuffer writeFloat(float val)

writeDouble

public BytesBuffer writeDouble(double val)

peek
```
public byte peek()
```

peekLast
```
public byte peekLast()
```

read
```
public byte read()
```

read
```
public byte[] read(int length)
```

readBoolean
```
public boolean readBoolean()
```

readChar
```
public char readChar()
```

readShort
```
public short readShort()
```

readInt
```
public int readInt()
```

readLong
```
public long readLong()
```

readFloat
```
public float readFloat()
```

readDouble
```
public double readDouble()
```

writeBytes

public BytesBuffer writeBytes(byte[] bytes)

readBytes
```
public byte[] readBytes()
```

writeBigBytes

public BytesBuffer writeBigBytes(byte[] bytes)

readBigBytes
```
public byte[] readBigBytes()
```

writeStringRaw

public BytesBuffer writeStringRaw(String val)

writeString

public BytesBuffer writeString(String val)

readString
```
public String readString()
```

writeStringWithEnding

public BytesBuffer writeStringWithEnding(String value)

readStringWithEnding
```
public String readStringWithEnding()
```

writeStringToRemaining

public BytesBuffer writeStringToRemaining(String value)

readStringFromRemaining

public String readStringFromRemaining()

writeUInt8

public BytesBuffer writeUInt8(int val)

readUInt8
```
public int readUInt8()
```

writeUInt16

public BytesBuffer writeUInt16(int val)

readUInt16
```
public int readUInt16()
```

writeUInt32

public BytesBuffer writeUInt32(long val)

readUInt32
```
public long readUInt32()
```

writeVInt

public BytesBuffer writeVInt(int value)

readVInt
```
public int readVInt()
```

writeVLong

public BytesBuffer writeVLong(long value)

readVLong
```
public long readVLong()
```

writeId
```
public BytesBuffer writeId(Id id)
```

writeId

public BytesBuffer writeId(Id id,
                           boolean big)

writeIndexId

public BytesBuffer writeIndexId(Id id,
                                HugeType type)

writeIndexId

public BytesBuffer writeIndexId(Id id,
                                HugeType type,
                                boolean withEnding)

writeProperty

public void writeProperty(DataType dataType,
                          Object value)

Class BytesBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Field Detail

BYTE_LEN

SHORT_LEN

INT_LEN

LONG_LEN

CHAR_LEN

FLOAT_LEN

DOUBLE_LEN

BLOB_LEN

UINT8_MAX

UINT16_MAX

UINT32_MAX

ID_LEN_MASK

ID_LEN_MAX

BIG_ID_LEN_MAX

STRING_ENDING_BYTE

STRING_ENDING_BYTE_FF

STRING_LEN_MAX

BLOB_LEN_MAX

INDEX_HASH_ID_THRESHOLD

DEFAULT_CAPACITY

MAX_BUFFER_CAPACITY

BUF_EDGE_ID

BUF_PROPERTY

Constructor Detail

BytesBuffer

BytesBuffer

BytesBuffer

Method Detail

allocate

wrap

wrap

wrap

asByteBuffer

forReadWritten

forReadAll

array

bytes

position

copyFrom

remaining

write

write

write

write

writeBoolean

writeChar

writeShort

writeInt

writeLong

writeFloat

writeDouble

peek

peekLast

read

read

readBoolean

readChar

readShort

readInt

readLong

readFloat

readDouble

writeBytes

readBytes

writeBigBytes

readBigBytes

writeStringRaw

writeString

readString

writeStringWithEnding

readStringWithEnding

writeStringToRemaining

readStringFromRemaining