com.devexperts.io

Class BufferedOutput

java.lang.Object

java.io.OutputStream

com.devexperts.io.BufferedOutput

All Implemented Interfaces:

Closeable, DataOutput, Flushable, ObjectOutput, AutoCloseable

Direct Known Subclasses:

ByteArrayOutput, ChunkedOutput, StreamOutput

public abstract class BufferedOutput
extends OutputStream
implements ObjectOutput

An efficient buffered implementation of data output API. It is attributed with underlying byte buffer, position and limit:

• The underlying byte buffer provides space for and holds data being written. It is never null.
• The position is an index of the next byte to be written. It is never negative and is never greater than the limit.
• The limit restricts allowed values for position. It is usually equal to underlying buffer capacity.

This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buffer
protected static byte[]	EMPTY_BYTE_ARRAY
protected int	limit
protected int	position
protected long	totalPositionBase

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BufferedOutput() Creates new instance with empty buffer.

Method Summary

Modifier and Type	Method and Description
protected void	checkEOB() Throws IllegalStateException if expression (position != limit) is true.
protected abstract void	needSpace() This method is invoked when output methods need more space to write data.
long	totalPosition() Returns total position of this output stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)
void	writeAllFromChunkList(ChunkList chunks, Object owner) Writes all data from specified chunk list into this buffered output.
void	writeBoolean(boolean v)
void	writeByte(int v)
void	writeByteArray(byte[] bytes) Writes an array of bytes in a compact encapsulation format.
void	writeBytes(String str)
void	writeChar(int v)
void	writeChars(String str)
void	writeCompactInt(int v) Writes an int value in a compact format (see IOUtil).
void	writeCompactLong(long v) Writes a long value in a compact format (see IOUtil).
void	writeDouble(double v)
void	writeFloat(float v)
void	writeFromByteBuffer(ByteBuffer buffer) Writes data from specified byte buffer into this buffered output.
void	writeFromChunk(Chunk chunk, Object owner) Writes data from specified chunk into this buffered output.
void	writeFromDataInput(DataInput in, long length) Writes data from specified data input into this buffered output.
long	writeFromInputStream(InputStream in, long length) Writes data from specified input stream into this buffered output.
void	writeInt(int v)
void	writeLong(long v)
void	writeMarshalled(Marshalled<?> marshalled) Writes a Marshalled object to a byte stream.
void	writeObject(Object obj) Write an object to the underlying storage or stream in a compact encapsulation format using IOUtil.writeObject.
void	writeProperties(Map<String,String> properties) Write provided properties in compact format.
void	writeShort(int v)
void	writeUTF(String str)
void	writeUTFChar(int codePoint) Writes a Unicode code point in a UTF-8 format.
void	writeUTFString(String str) Writes a string in a UTF-8 format with compact encapsulation (see IOUtil).

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

Methods inherited from interface java.io.ObjectOutput

close, flush

Field Detail

EMPTY_BYTE_ARRAY

protected static final byte[] EMPTY_BYTE_ARRAY

buffer

protected byte[] buffer

position

protected int position

limit

protected int limit

totalPositionBase

protected long totalPositionBase

Constructor Detail

BufferedOutput

protected BufferedOutput()

Creates new instance with empty buffer.

Method Detail

needSpace

protected abstract void needSpace()
                           throws IOException

This method is invoked when output methods need more space to write data. This method must ensure that expression (position < limit) is true or throw an exception. This method may block if needed. This method is allowed to update buffer, position and limit fields as needed and should maintain totalPositionBase accordingly.

Throws:

IOException - if an I/O error occurs

checkEOB

protected final void checkEOB()

Throws IllegalStateException if expression (position != limit) is true.

totalPosition

public final long totalPosition()

Returns total position of this output stream. The total position is defined as an offset of the next byte to be written from the beginning of the stream. It is equal to the number of written bytes.

write

public final void write(int b)
                 throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Specified by:

write in class OutputStream

Throws:

IOException

write

public final void write(byte[] b)
                 throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class OutputStream

Throws:

IOException

writeBoolean

public final void writeBoolean(boolean v)
                        throws IOException

Specified by:

writeBoolean in interface DataOutput

Throws:

IOException

writeByte

public final void writeByte(int v)
                     throws IOException

Specified by:

writeByte in interface DataOutput

Throws:

IOException

writeShort

public final void writeShort(int v)
                      throws IOException

Specified by:

writeShort in interface DataOutput

Throws:

IOException

writeChar

public final void writeChar(int v)
                     throws IOException

Specified by:

writeChar in interface DataOutput

Throws:

IOException

writeInt

public final void writeInt(int v)
                    throws IOException

Specified by:

writeInt in interface DataOutput

Throws:

IOException

writeLong

public final void writeLong(long v)
                     throws IOException

Specified by:

writeLong in interface DataOutput

Throws:

IOException

writeFloat

public final void writeFloat(float v)
                      throws IOException

Specified by:

writeFloat in interface DataOutput

Throws:

IOException

writeDouble

public final void writeDouble(double v)
                       throws IOException

Specified by:

writeDouble in interface DataOutput

Throws:

IOException

writeBytes

public final void writeBytes(String str)
                      throws IOException

Specified by:

writeBytes in interface DataOutput

Throws:

IOException

writeChars

public final void writeChars(String str)
                      throws IOException

Specified by:

writeChars in interface DataOutput

Throws:

IOException

writeUTF

public final void writeUTF(String str)
                    throws IOException

Specified by:

writeUTF in interface DataOutput

Throws:

IOException

writeProperties

public final void writeProperties(@Nonnull
                                  Map<String,String> properties)
                           throws IOException

Write provided properties in compact format.

Encoding: mapSize:compactInt (key:UTFString, value:UTFString)*

Parameters:

properties - properties to be written

Throws:

IOException - if an I/O error occurs

See Also:

BufferedInput.readProperties(java.util.Map<java.lang.String, java.lang.String>)

writeObject

public final void writeObject(Object obj)
                       throws IOException

Write an object to the underlying storage or stream in a compact encapsulation format using IOUtil.writeObject.

Specified by:

writeObject in interface ObjectOutput

Parameters:

obj - the object to be written.

Throws:

IOException - if an I/O error occurs

writeMarshalled

public final void writeMarshalled(Marshalled<?> marshalled)
                           throws IOException

Writes a Marshalled object to a byte stream. This method writes object length using Marshaller.writeMarshalledLength, followed by the contents of the marshalled byte array.

When the serialization marshaller is used in marshalled object, then this method writes the same bytes as would have been been produced by writeObject method on the object repesentation of the marshalled object. The corresponding bytes can be later read either using BufferedInput.readMarshalled(Marshaller.SERIALIZATION) or using BufferedInput.readObject().

Parameters:

marshalled - the marshalled object to be written.

Throws:

IOException - if an I/O error occurs

writeCompactInt

public final void writeCompactInt(int v)
                           throws IOException

Writes an int value in a compact format (see IOUtil). Equivalent to IOUtil.writeCompactInt(java.io.DataOutput, int) method.

Parameters:

v - the int value to be written

Throws:

IOException - if an I/O error occurs

writeCompactLong

public final void writeCompactLong(long v)
                            throws IOException

Writes a long value in a compact format (see IOUtil). Equivalent to IOUtil.writeCompactLong(java.io.DataOutput, long) method.

Parameters:

v - the long value to be written

Throws:

IOException - if an I/O error occurs

writeByteArray

public final void writeByteArray(byte[] bytes)
                          throws IOException

Writes an array of bytes in a compact encapsulation format. This method defines length as a number of bytes. Equivalent to IOUtil.writeByteArray(java.io.DataOutput, byte[]) method.

Parameters:

bytes - the byte array to be written

Throws:

IOException - if an I/O error occurs

writeUTFChar

public final void writeUTFChar(int codePoint)
                        throws IOException

Writes a Unicode code point in a UTF-8 format. The surrogate code points are accepted and written in a CESU-8 format. Equivalent to IOUtil.writeUTFChar(java.io.DataOutput, int) method.

Parameters:

codePoint - the code point to be written

Throws:

UTFDataFormatException - if codePoint is not a valid Unicode character

IOException - if an I/O error occurs

writeUTFString

public final void writeUTFString(String str)
                          throws IOException

Writes a string in a UTF-8 format with compact encapsulation (see IOUtil). Unpaired surrogate code points are accepted and written in a CESU-8 format. This method defines length as a number of bytes. Equivalent to IOUtil.writeUTFString(java.io.DataOutput, java.lang.String) method.

Parameters:

str - the string to be written

Throws:

UTFDataFormatException - if str is too long

IOException - if an I/O error occurs

writeFromInputStream

public long writeFromInputStream(InputStream in,
                                 long length)
                          throws IOException

Writes data from specified input stream into this buffered output. The number of bytes actually written is returned as an integer.

Parameters:

in - the source input stream to read from

length - maximum number of bytes to write

Returns:

total number of bytes written from the input stream

Throws:

IOException - if an I/O error occurs

writeFromDataInput

public void writeFromDataInput(DataInput in,
                               long length)
                        throws IOException

Writes data from specified data input into this buffered output.

Parameters:

in - the source data input to read from

length - number of bytes to write

Throws:

IOException - if an I/O error occurs

writeFromByteBuffer

public void writeFromByteBuffer(ByteBuffer buffer)
                         throws IOException

Writes data from specified byte buffer into this buffered output.

Parameters:

buffer - the source byte buffer to read from

Throws:

IOException - if an I/O error occurs

writeFromChunk

public void writeFromChunk(Chunk chunk,
                           Object owner)
                    throws IOException

Writes data from specified chunk into this buffered output. Returns the chunk into the pool (or invalidates it if it does not correspond to any pool), unless the chunk was read-only. A reference to the chunk is considered to become invalid after invocation of this method and may no longer be used, unless the chunk was read-only.

Parameters:

chunk - the source chunk of bytes

owner - current owner of the chunk

Throws:

IllegalStateException - if the chunk is not read-only and its current owner differs from the one specified

IOException - if an I/O error occurs

writeAllFromChunkList

public void writeAllFromChunkList(ChunkList chunks,
                                  Object owner)
                           throws IOException

Writes all data from specified chunk list into this buffered output. Returns the chunk into the pool (or invalidates it if it does not correspond to any pool), unless the chunk list was read-only. A reference to the chunk list is considered to become invalid after invocation of this method and may no longer be used, unless the chunk list was read-only.

Parameters:

chunks - the source chunk list

owner - current owner of the chunk list

Throws:

IllegalStateException - if the chunk list is not read-only and its current owner differs from the one specified

IOException - if an I/O error occurs