org.apache.giraph.utils

Class ExtendedByteArrayDataOutput

java.lang.Object

java.io.OutputStream

java.io.ByteArrayOutputStream

org.apache.giraph.utils.ExtendedByteArrayDataOutput

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable, ExtendedDataOutput

public class ExtendedByteArrayDataOutput
extends ByteArrayOutputStream
implements ExtendedDataOutput

Adds some functionality to ByteArrayOutputStream, such as an option to write int value over previously written data and directly get the byte array.

Field Summary

Fields inherited from class java.io.ByteArrayOutputStream

buf, count

Constructor Summary

Constructors

Constructor and Description
ExtendedByteArrayDataOutput() Creates a new byte array output stream.
ExtendedByteArrayDataOutput(byte[] buf) Uses the byte array provided or if null, use a default size
ExtendedByteArrayDataOutput(byte[] buf, int pos) Uses the byte array provided at the given pos
ExtendedByteArrayDataOutput(int size) Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary

Modifier and Type	Method and Description
void	ensureWritable(int minSize) Ensure that backing byte structure has at least minSize additional bytes
byte[]	getByteArray() Get the internal byte array (if possible), read-only
int	getPos() Get the position in the output stream
void	skipBytes(int bytesToSkip) Skip some number of bytes.
byte[]	toByteArray(int offset, int length) Return a copy of slice of byte array
void	writeBoolean(boolean v)
void	writeByte(int v)
void	writeBytes(String s)
void	writeChar(int v)
void	writeChars(String s)
void	writeDouble(double v)
void	writeFloat(float v)
void	writeInt(int v)
void	writeInt(int position, int value) In order to write a size as a first part of an data output, it is useful to be able to write an int at an arbitrary location in the stream
void	writeLong(long v)
void	writeShort(int v)
void	writeUTF(String s)

Methods inherited from class java.io.ByteArrayOutputStream

close, reset, size, toByteArray, toString, toString, toString, write, write, writeTo

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.giraph.utils.ExtendedDataOutput

reset, toByteArray

Methods inherited from interface java.io.DataOutput

write, write, write

Constructor Detail

ExtendedByteArrayDataOutput

public ExtendedByteArrayDataOutput(byte[] buf)

Uses the byte array provided or if null, use a default size

Parameters:

buf - Buffer to use

ExtendedByteArrayDataOutput

public ExtendedByteArrayDataOutput(byte[] buf,
                                   int pos)

Uses the byte array provided at the given pos

Parameters:

buf - Buffer to use

pos - Position in the buffer to start writing from

ExtendedByteArrayDataOutput

public ExtendedByteArrayDataOutput()

Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.

ExtendedByteArrayDataOutput

public ExtendedByteArrayDataOutput(int size)

Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Parameters:

size - the initial size.

Throws:

IllegalArgumentException - if size is negative.

Method Detail

writeBoolean

public void writeBoolean(boolean v)
                  throws IOException

Specified by:

writeBoolean in interface DataOutput

Throws:

IOException

writeByte

public void writeByte(int v)
               throws IOException

Specified by:

writeByte in interface DataOutput

Throws:

IOException

writeShort

public void writeShort(int v)
                throws IOException

Specified by:

writeShort in interface DataOutput

Throws:

IOException

writeChar

public void writeChar(int v)
               throws IOException

Specified by:

writeChar in interface DataOutput

Throws:

IOException

writeInt

public void writeInt(int v)
              throws IOException

Specified by:

writeInt in interface DataOutput

Throws:

IOException

writeLong

public void writeLong(long v)
               throws IOException

Specified by:

writeLong in interface DataOutput

Throws:

IOException

writeFloat

public void writeFloat(float v)
                throws IOException

Specified by:

writeFloat in interface DataOutput

Throws:

IOException

writeDouble

public void writeDouble(double v)
                 throws IOException

Specified by:

writeDouble in interface DataOutput

Throws:

IOException

writeBytes

public void writeBytes(String s)
                throws IOException

Specified by:

writeBytes in interface DataOutput

Throws:

IOException

writeChars

public void writeChars(String s)
                throws IOException

Specified by:

writeChars in interface DataOutput

Throws:

IOException

writeUTF

public void writeUTF(String s)
              throws IOException

Specified by:

writeUTF in interface DataOutput

Throws:

IOException

ensureWritable

public void ensureWritable(int minSize)

Description copied from interface: ExtendedDataOutput

Ensure that backing byte structure has at least minSize additional bytes

Specified by:

ensureWritable in interface ExtendedDataOutput

Parameters:

minSize - additional size required

skipBytes

public void skipBytes(int bytesToSkip)

Description copied from interface: ExtendedDataOutput

Skip some number of bytes.

Specified by:

skipBytes in interface ExtendedDataOutput

Parameters:

bytesToSkip - Number of bytes to skip

writeInt

public void writeInt(int position,
                     int value)

Description copied from interface: ExtendedDataOutput

In order to write a size as a first part of an data output, it is useful to be able to write an int at an arbitrary location in the stream

Specified by:

writeInt in interface ExtendedDataOutput

Parameters:

position - Byte position in the output stream

value - Value to write

toByteArray

public byte[] toByteArray(int offset,
                          int length)

Description copied from interface: ExtendedDataOutput

Return a copy of slice of byte array

Specified by:

toByteArray in interface ExtendedDataOutput

Parameters:

offset - offset of array

length - length of slice

Returns:

byte array

getByteArray

public byte[] getByteArray()

Description copied from interface: ExtendedDataOutput

Get the internal byte array (if possible), read-only

Specified by:

getByteArray in interface ExtendedDataOutput

Returns:

Internal byte array (do not modify)

getPos

public int getPos()

Description copied from interface: ExtendedDataOutput

Get the position in the output stream

Specified by:

getPos in interface ExtendedDataOutput

Returns:

Position in the output stream