org.postgresql.util.ByteStreamWriter Maven / Gradle / Ivy
Show all versions of jdbc-yugabytedb Show documentation
/*
* Copyright (c) 2020, PostgreSQL Global Development Group
* See the LICENSE file in the project root for more information.
*/
package org.postgresql.util;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* A class that can be used to set a byte array parameter by writing to an OutputStream.
*
* The intended use case is wanting to write data to a byte array parameter that is stored off
* heap in a direct memory pool or in some other form that is inconvenient to assemble into a single
* heap-allocated buffer.
* Users should write their own implementation depending on the
* original data source. The driver provides a built-in implementation supporting the {@link
* java.nio.ByteBuffer} class, see {@link ByteBufferByteStreamWriter}.
* Intended usage is to simply pass in an instance using
* {@link java.sql.PreparedStatement#setObject(int, Object)}:
*
* int bufLength = someBufferObject.length();
* preparedStatement.setObject(1, new MyByteStreamWriter(bufLength, someBufferObject));
*
* The length must be known ahead of the stream being written to.
* This provides the application more control over memory management than calling
* {@link java.sql.PreparedStatement#setBinaryStream(int, InputStream)} as with the latter the
* caller has no control over the buffering strategy.
*/
public interface ByteStreamWriter {
/**
* Returns the length of the stream.
*
* This must be known ahead of calling {@link #writeTo(ByteStreamTarget)}.
*
* @return the number of bytes in the stream.
*/
int getLength();
/**
* Write the data to the provided {@link OutputStream}.
*
* Should not write more than {@link #getLength()} bytes. If attempted, the provided stream
* will throw an {@link java.io.IOException}.
*
* @param target the stream to write the data to
* @throws IOException if the underlying stream throws or there is some other error.
*/
void writeTo(ByteStreamTarget target) throws IOException;
/**
* Provides a target to write bytes to.
*/
interface ByteStreamTarget {
/**
* Provides an output stream to write bytes to.
*
* @return an output stream
*/
OutputStream getOutputStream();
}
}