Package org.gnome.gio

Class Win32InputStream

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.Win32InputStream

All Implemented Interfaces:

Proxy, AutoCloseable, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public class Win32InputStream
extends InputStream

GWin32InputStream implements InputStream for reading from a Windows file handle.

Note that <gio/gwin32inputstream.h> belongs to the Windows-specific GIO interfaces, thus you have to use the gio-windows-2.0.pc pkg-config file when using it.

Nested Class Summary

Nested Classes

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

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

InputStream.InputStreamClass, InputStream.InputStreamImpl

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Win32InputStream(@Nullable MemorySegment handle_, boolean closeHandle)	Creates a new GWin32InputStream for the given handle_.
Win32InputStream(MemorySegment address)	Create a Win32InputStream proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Win32InputStream	asParent()	Returns this instance as if it were its parent type.
static Win32InputStream.Builder<? extends Win32InputStream.Builder>	builder()	A Win32InputStream.Builder object constructs a Win32InputStream with the specified properties.
boolean	getCloseHandle()	Returns whether the handle of this Win32InputStream will be closed when the stream is closed.
MemorySegment	getHandle()	Return the Windows file handle that the stream reads from.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the Win32InputStream class
void	setCloseHandle(boolean closeHandle)	Sets whether the handle of this Win32InputStream shall be closed when the stream is closed.

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, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.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 io.github.jwharm.javagi.gio.AutoCloseable

close

Constructor Details

Win32InputStream

public Win32InputStream(MemorySegment address)

Create a Win32InputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Win32InputStream

public Win32InputStream(@Nullable
 @Nullable MemorySegment handle_,
 boolean closeHandle)
                 throws UnsupportedPlatformException

Creates a new GWin32InputStream for the given handle_.

If closeHandle is true, the handle will be closed when the stream is closed.

Note that "handle" here means a Win32 HANDLE, not a "file descriptor" as used in the Windows C libraries.

Parameters:

handle_ - a Win32 file handle

closeHandle - true to close the handle when done

Throws:

UnsupportedPlatformException - when run on a platform other than windows

Method Details

getType

public static Type getType()

Get the GType of the Win32InputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Win32InputStream 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 InputStream

getCloseHandle

public boolean getCloseHandle()

Returns whether the handle of this Win32InputStream will be closed when the stream is closed.

Returns:

true if the handle is closed when done

getHandle

public MemorySegment getHandle()

Return the Windows file handle that the stream reads from.

Returns:

The file handle of this Win32InputStream

setCloseHandle

public void setCloseHandle(boolean closeHandle)

Sets whether the handle of this Win32InputStream shall be closed when the stream is closed.

Parameters:

closeHandle - true to close the handle when done

builder

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

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