Package com.alibaba.graphscope.serialization

Class FFIByteVectorOutputStream

java.lang.Object

java.io.OutputStream

com.alibaba.graphscope.serialization.FFIByteVectorOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, AutoCloseable

public class FFIByteVectorOutputStream
extends OutputStream
implements DataOutput

Constructor Summary

Constructors

Constructor	Description
FFIByteVectorOutputStream()
FFIByteVectorOutputStream(FFIByteVector vector)

Method Summary

Modifier and Type	Method	Description
long	bytesWriten()	Return how many bytes has been written.
void	close()
void	finishSetting()	Finish setting, shrink vector size to offset.
FFIByteVector	getVector()
void	reset()	Reset actually reset the write position, the size kept unchanged.
void	resize(long size)
void	write(int b)	Writes the specified byte to this output stream.
void	writeBoolean(boolean v)	Writes a boolean value to this output stream.
void	writeByte(int v)	Writes to the output stream the eight low- order bits of the argument v.
void	writeBytes(StringView s)
void	writeBytes(String s)	Writes a string to the output stream.
void	writeChar(int v)	Writes a char value, which is comprised of two bytes, to the output stream.
void	writeChars(String s)	Writes every character in the string s, to the output stream, in order, two bytes per character.
void	writeDouble(double v)	Writes a double value, which is comprised of eight bytes, to the output stream.
void	writeFloat(float v)	Writes a float value, which is comprised of four bytes, to the output stream.
void	writeInt(int v)	Writes an int value, which is comprised of four bytes, to the output stream.
void	writeInt(int index, int v)
void	writeLong(int index, long v)
void	writeLong(long v)	Writes a long value, which is comprised of eight bytes, to the output stream.
void	writeShort(int v)	Writes two bytes to the output stream to represent the value of the argument.
void	writeUTF(String s)	Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s.

Methods inherited from class java.io.OutputStream

flush, nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.DataOutput

write, write

Constructor Detail

FFIByteVectorOutputStream

public FFIByteVectorOutputStream()

FFIByteVectorOutputStream

public FFIByteVectorOutputStream(FFIByteVector vector)

Method Detail

resize

public void resize(long size)

reset

public void reset()

Reset actually reset the write position, the size kept unchanged.

getVector

public FFIByteVector getVector()

bytesWriten

public long bytesWriten()

Return how many bytes has been written.

Returns:

finishSetting

public void finishSetting()

Finish setting, shrink vector size to offset.

writeBoolean

public void writeBoolean(boolean v)
                  throws IOException

Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.

Specified by:

writeBoolean in interface DataOutput

Parameters:

v - the boolean to be written.

Throws:

IOException - if an I/O error occurs.

writeByte

public void writeByte(int v)
               throws IOException

Writes to the output stream the eight low- order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.

Specified by:

writeByte in interface DataOutput

Parameters:

v - the byte value to be written.

Throws:

IOException - if an I/O error occurs.

writeShort

public void writeShort(int v)
                throws IOException

Writes two bytes to the output stream to represent the value of the argument. The byte values to be written, in the order shown, are:

 (byte)(0xff & (v >> 8))
 (byte)(0xff & v)
 

The bytes written by this method may be read by the readShort method of interface DataInput , which will then return a short equal to (short)v.

Specified by:

writeShort in interface DataOutput

Parameters:

v - the short value to be written.

Throws:

IOException - if an I/O error occurs.

writeChar

public void writeChar(int v)
               throws IOException

Writes a char value, which is comprised of two bytes, to the output stream. The byte values to be written, in the order shown, are:

 (byte)(0xff & (v >> 8))
 (byte)(0xff & v)
 

The bytes written by this method may be read by the readChar method of interface DataInput , which will then return a char equal to (char)v.

Specified by:

writeChar in interface DataOutput

Parameters:

v - the char value to be written.

Throws:

IOException - if an I/O error occurs.

writeInt

public void writeInt(int v)
              throws IOException

Writes an int value, which is comprised of four bytes, to the output stream. The byte values to be written, in the order shown, are:

 (byte)(0xff & (v >> 24))
 (byte)(0xff & (v >> 16))
 (byte)(0xff & (v >>  8))
 (byte)(0xff & v)
 

The bytes written by this method may be read by the readInt method of interface DataInput , which will then return an int equal to v.

Specified by:

writeInt in interface DataOutput

Parameters:

v - the int value to be written.

Throws:

IOException - if an I/O error occurs.

writeInt

public void writeInt(int index,
                     int v)

writeLong

public void writeLong(long v)
               throws IOException

Writes a long value, which is comprised of eight bytes, to the output stream. The byte values to be written, in the order shown, are:

 (byte)(0xff & (v >> 56))
 (byte)(0xff & (v >> 48))
 (byte)(0xff & (v >> 40))
 (byte)(0xff & (v >> 32))
 (byte)(0xff & (v >> 24))
 (byte)(0xff & (v >> 16))
 (byte)(0xff & (v >>  8))
 (byte)(0xff & v)
 

The bytes written by this method may be read by the readLong method of interface DataInput , which will then return a long equal to v.

Specified by:

writeLong in interface DataOutput

Parameters:

v - the long value to be written.

Throws:

IOException - if an I/O error occurs.

writeLong

public void writeLong(int index,
                      long v)

writeFloat

public void writeFloat(float v)
                throws IOException

Writes a float value, which is comprised of four bytes, to the output stream. It does this as if it first converts this float value to an int in exactly the manner of the Float.floatToIntBits method and then writes the int value in exactly the manner of the writeInt method. The bytes written by this method may be read by the readFloat method of interface DataInput, which will then return a float equal to v.

Specified by:

writeFloat in interface DataOutput

Parameters:

v - the float value to be written.

Throws:

IOException - if an I/O error occurs.

writeDouble

public void writeDouble(double v)
                 throws IOException

Writes a double value, which is comprised of eight bytes, to the output stream. It does this as if it first converts this double value to a long in exactly the manner of the Double.doubleToLongBits method and then writes the long value in exactly the manner of the writeLong method. The bytes written by this method may be read by the readDouble method of interface DataInput, which will then return a double equal to v.

Specified by:

writeDouble in interface DataOutput

Parameters:

v - the double value to be written.

Throws:

IOException - if an I/O error occurs.

writeBytes

public void writeBytes(String s)
                throws IOException

Writes a string to the output stream. For every character in the string s, taken in order, one byte is written to the output stream. If s is null, a NullPointerException is thrown.

If s.length is zero, then no bytes are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, one byte is written, the low-order byte, in exactly the manner of the writeByte method . The high-order eight bits of each character in the string are ignored.

Specified by:

writeBytes in interface DataOutput

Parameters:

s - the string of bytes to be written.

Throws:

IOException - if an I/O error occurs.

writeBytes

public void writeBytes(StringView s)
                throws IOException

Throws:

IOException

writeChars

public void writeChars(String s)
                throws IOException

Writes every character in the string s, to the output stream, in order, two bytes per character. If s is null, a NullPointerException is thrown. If s.length is zero, then no characters are written. Otherwise, the character s[0] is written first, then s[1], and so on; the last character written is s[s.length-1]. For each character, two bytes are actually written, high-order byte first, in exactly the manner of the writeChar method.

Specified by:

writeChars in interface DataOutput

Parameters:

s - the string value to be written.

Throws:

IOException - if an I/O error occurs.

writeUTF

public void writeUTF(String s)
              throws IOException

Writes two bytes of length information to the output stream, followed by the modified UTF-8 representation of every character in the string s. If s is null, a NullPointerException is thrown. Each character in the string s is converted to a group of one, two, or three bytes, depending on the value of the character.

If a character c is in the range \u0001 through \u007f, it is represented by one byte:

(byte)c 

If a character c is \u0000 or is in the range \u0080 through \u07ff, then it is represented by two bytes, to be written in the order shown:

 (byte)(0xc0 | (0x1f & (c >> 6)))
 (byte)(0x80 | (0x3f & c))
 

If a character c is in the range \u0800 through uffff, then it is represented by three bytes, to be written in the order shown:

 (byte)(0xe0 | (0x0f & (c >> 12)))
 (byte)(0x80 | (0x3f & (c >>  6)))
 (byte)(0x80 | (0x3f & c))
 

First, the total number of bytes needed to represent all the characters of s is calculated. If this number is larger than 65535, then a UTFDataFormatException is thrown. Otherwise, this length is written to the output stream in exactly the manner of the writeShort method; after this, the one-, two-, or three-byte representation of each character in the string s is written.

The bytes written by this method may be read by the readUTF method of interface DataInput , which will then return a String equal to s.

Specified by:

writeUTF in interface DataOutput

Parameters:

s - the string value to be written.

Throws:

IOException - if an I/O error occurs.

write

public void write(int b)
           throws IOException

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Subclasses of OutputStream must provide an implementation for this method.

Specified by:

write in interface DataOutput

Specified by:

write in class OutputStream

Parameters:

b - the byte.

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException