Top Description Fields Constructors Methods
org.postgresql.largeobject

public Class BlobOutputStream

extends OutputStream
Class Inheritance
Imports
org.postgresql.jdbc.ResourceLock, org.postgresql.util.ByteStreamWriter, .GT, org.checkerframework.checker.index.qual.Positive, org.checkerframework.checker.nullness.qual.Nullable, java.io.IOException, .OutputStream, java.nio.ByteBuffer, java.sql.SQLException
This implements a basic output stream that writes to a LargeObject.

Field Summary

Modifier and TypeField and Description
private @Nullable byte[]
buf

Buffer.

private int
bufferPosition

Position within the buffer.

pack-priv static final int
DEFAULT_MAX_BUFFER_SIZE

private @Nullable LargeObject
lo

The parent LargeObject.

private final ResourceLock
lock

private final @Positive int
maxBufferSize

Size of the buffer (default 1K).

Constructor Summary

AccessConstructor and Description
public
BlobOutputStream(LargeObject
LargeObject
lo)

Create an OutputStream to a large object.

public
BlobOutputStream(LargeObject
LargeObject
lo, int
The size of the buffer for single-byte writes
bufferSize)

Create an OutputStream to a large object.

Method Summary

Modifier and TypeMethod and Description
private LargeObject
checkClosed()

public void
close()

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with this stream.

public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out.

private byte[]

Returns:

new buffer
growBuffer(int
the number of extra bytes that should fit in the buffer
extraBytes)

Grows an internal buffer to ensure the extra bytes fit in the buffer.

public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.

public void
write(byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Inherited from java.io.OutputStream:
nullOutputStreamwrite

Field Detail

bufback to summary
private @Nullable byte[] buf

Buffer.

bufferPositionback to summary
private int bufferPosition

Position within the buffer.

DEFAULT_MAX_BUFFER_SIZEback to summary
pack-priv static final int DEFAULT_MAX_BUFFER_SIZE
loback to summary
private @Nullable LargeObject lo

The parent LargeObject.

lockback to summary
private final ResourceLock lock
maxBufferSizeback to summary
private final @Positive int maxBufferSize

Size of the buffer (default 1K).

Constructor Detail

BlobOutputStreamback to summary
public BlobOutputStream(LargeObject lo)

Create an OutputStream to a large object.

Parameters
lo:LargeObject

LargeObject

BlobOutputStreamback to summary
public BlobOutputStream(LargeObject lo, int bufferSize)

Create an OutputStream to a large object.

Parameters
lo:LargeObject

LargeObject

bufferSize:int

The size of the buffer for single-byte writes

Method Detail

checkClosedback to summary
private LargeObject checkClosed() throws IOException
closeback to summary
public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
flushback to summary
public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
growBufferback to summary
private byte[] growBuffer(int extraBytes)

Grows an internal buffer to ensure the extra bytes fit in the buffer.

Parameters
extraBytes:int

the number of extra bytes that should fit in the buffer

Returns:byte[]

new buffer

writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

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.

Parameters
b:int

the byte.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.