Package org.gnome.gio

Class BufferedInputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.FilterInputStream

org.gnome.gio.BufferedInputStream

All Implemented Interfaces:

AutoCloseable, Seekable, Proxy, AutoCloseable

Direct Known Subclasses:

DataInputStream

@Generated("io.github.jwharm.JavaGI")
public class BufferedInputStream
extends FilterInputStream
implements Seekable

Buffered input stream implements FilterInputStream and provides for buffered reads.

By default, GBufferedInputStream's buffer size is set at 4 kilobytes.

To create a buffered input stream, use BufferedInputStream(), or sized(org.gnome.gio.InputStream, long) to specify the buffer's size at construction.

To get the size of a buffer within a buffered input stream, use getBufferSize(). To change the size of a buffered input stream's buffer, use setBufferSize(long). Note that the buffer's size cannot be reduced below the size of the data within the buffer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BufferedInputStream.BufferedInputStreamClass
static class	BufferedInputStream.Builder<B extends BufferedInputStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

Nested classes/interfaces inherited from class org.gnome.gio.FilterInputStream

FilterInputStream.FilterInputStream$Impl, FilterInputStream.FilterInputStreamClass

Nested classes/interfaces inherited from class org.gnome.gio.InputStream

InputStream.InputStream$Impl, InputStream.InputStreamClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.Seekable

Seekable.Seekable$Impl, Seekable.SeekableIface

Constructor Summary

Constructors

Constructor	Description
BufferedInputStream()	Creates a new BufferedInputStream.
BufferedInputStream(MemorySegment address)	Create a BufferedInputStream proxy instance for the provided memory address.
BufferedInputStream(InputStream baseStream)	Creates a new InputStream from the given baseStream, with a buffer set to the default size (4 kilobytes).

Method Summary

Modifier and Type	Method	Description
protected BufferedInputStream	asParent()	Returns this instance as if it were its parent type.
static BufferedInputStream.Builder<? extends BufferedInputStream.Builder>	builder()	A BufferedInputStream.Builder object constructs a BufferedInputStream with the specified properties.
long	fill(long count, @Nullable Cancellable cancellable)	Tries to read count bytes from the stream into the buffer.
void	fillAsync(long count, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Reads data into stream's buffer asynchronously, up to count size.
long	fillFinish(AsyncResult result)	Finishes an asynchronous read.
long	getAvailable()	Gets the size of the available data within the stream.
long	getBufferSize()	Gets the size of the input buffer.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the BufferedInputStream class
long	peek(@org.jspecify.annotations.Nullable byte @Nullable [] buffer, long offset)	Peeks in the buffer, copying data of size count into buffer, offset offset bytes.
byte[]	peekBuffer()	Returns the buffer with the currently available bytes.
int	readInt(@Nullable Cancellable cancellable)	Tries to read a single byte from the stream or the buffer.
void	setBufferSize(long size)	Sets the size of the internal buffer of this BufferedInputStream to size, or to the size of the contents of the buffer.
static InputStream	sized(InputStream baseStream, long size)	Creates a new BufferedInputStream from the given baseStream, with a buffer set to size.

Methods inherited from class org.gnome.gio.FilterInputStream

getBaseStream, getCloseBaseStream, setCloseBaseStream

Methods inherited from class org.gnome.gio.InputStream

clearPending, close, closeAsync, closeFinish, closeFn, hasPending, isClosed, read, readAll, readAllAsync, readAllFinish, readAsync, readBytes, readBytesAsync, readBytesFinish, readFinish, readFn, setPending, skip, skipAsync, skipFinish

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javagi.gio.AutoCloseable

close

Methods inherited from interface org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gio.Seekable

canSeek, canTruncate, seek, tell, truncate

Constructor Details

BufferedInputStream

public BufferedInputStream(MemorySegment address)

Create a BufferedInputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

BufferedInputStream

public BufferedInputStream(InputStream baseStream)

Creates a new InputStream from the given baseStream, with a buffer set to the default size (4 kilobytes).

Parameters:

baseStream - a InputStream

BufferedInputStream

public BufferedInputStream()

Creates a new BufferedInputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the BufferedInputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected BufferedInputStream asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class FilterInputStream

sized

public static InputStream sized(InputStream baseStream,
 long size)

Creates a new BufferedInputStream from the given baseStream, with a buffer set to size.

Parameters:

baseStream - a InputStream

size - a gsize

Returns:

a InputStream.

fill

public long fill(long count,
 @Nullable Cancellable cancellable)
          throws GErrorException

Tries to read count bytes from the stream into the buffer. Will block during this read.

If count is zero, returns zero and does nothing. A value of count larger than G_MAXSSIZE will cause a Gio.IOErrorEnum.INVALID_ARGUMENT error.

On success, the number of bytes read into the buffer is returned. It is not an error if this is not the same as the requested size, as it can happen e.g. near the end of a file. Zero is returned on end of file (or if count is zero), but never otherwise.

If count is -1 then the attempted read size is equal to the number of bytes that are required to fill the buffer.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

On error -1 is returned and error is set accordingly.

For the asynchronous, non-blocking, version of this function, see fillAsync(long, int, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback).

Parameters:

count - the number of bytes that will be read from the stream

cancellable - optional Cancellable object, NULL to ignore

Returns:

the number of bytes read into stream's buffer, up to count, or -1 on error.

Throws:

GErrorException - see GError

fillAsync

public void fillAsync(long count,
 int ioPriority,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Reads data into stream's buffer asynchronously, up to count size. ioPriority can be used to prioritize reads. For the synchronous version of this function, see fill(long, org.gnome.gio.Cancellable).

If count is -1 then the attempted read size is equal to the number of bytes that are required to fill the buffer.

Parameters:

count - the number of bytes that will be read from the stream

ioPriority - the I/O priority of the request

cancellable - optional Cancellable object

callback - a Gio.AsyncReadyCallback

fillFinish

public long fillFinish(AsyncResult result)
                throws GErrorException

Finishes an asynchronous read.

Parameters:

result - a AsyncResult

Returns:

a gssize of the read stream, or -1 on an error.

Throws:

GErrorException - see GError

getAvailable

public long getAvailable()

Gets the size of the available data within the stream.

Returns:

size of the available stream.

getBufferSize

public long getBufferSize()

Gets the size of the input buffer.

Returns:

the current buffer size.

peek

public long peek(@org.jspecify.annotations.Nullable byte @Nullable [] buffer,
 long offset)

Peeks in the buffer, copying data of size count into buffer, offset offset bytes.

Parameters:

buffer - a pointer to an allocated chunk of memory

offset - a gsize

Returns:

a gsize of the number of bytes peeked, or -1 on error.

peekBuffer

public byte[] peekBuffer()

Returns the buffer with the currently available bytes. The returned buffer must not be modified and will become invalid when reading from the stream or filling the buffer.

Returns:

read-only buffer

readInt

public int readInt(@Nullable Cancellable cancellable)
            throws GErrorException

Tries to read a single byte from the stream or the buffer. Will block during this read.

On success, the byte read from the stream is returned. On end of stream -1 is returned but it's not an exceptional error and error is not set.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gio.IOErrorEnum.CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error.

On error -1 is returned and error is set accordingly.

Parameters:

cancellable - optional Cancellable object, NULL to ignore

Returns:

the byte read from the stream, or -1 on end of stream or error.

Throws:

GErrorException - see GError

setBufferSize

public void setBufferSize(long size)

Sets the size of the internal buffer of this BufferedInputStream to size, or to the size of the contents of the buffer. The buffer can never be resized smaller than its current contents.

Parameters:

size - a gsize

builder

public static BufferedInputStream.Builder<? extends BufferedInputStream.Builder> builder()

A BufferedInputStream.Builder object constructs a BufferedInputStream with the specified properties. Use the various set...() methods to set properties, and finish construction with BufferedInputStream.Builder.build().

Returns:

the builder object