Package org.gnome.gio

Class DataOutputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.OutputStream

org.gnome.gio.FilterOutputStream

org.gnome.gio.DataOutputStream

All Implemented Interfaces:

AutoCloseable, Seekable, Proxy, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public class DataOutputStream
extends FilterOutputStream
implements Seekable

Data output stream implements OutputStream and includes functions for writing data directly to an output stream.

Nested Class Summary

Nested Classes

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

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

FilterOutputStream.FilterOutputStream$Impl, FilterOutputStream.FilterOutputStreamClass

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

OutputStream.OutputStream$Impl, OutputStream.OutputStreamClass

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
DataOutputStream()	Creates a new DataOutputStream.
DataOutputStream(MemorySegment address)	Create a DataOutputStream proxy instance for the provided memory address.
DataOutputStream(OutputStream baseStream)	Creates a new data output stream for baseStream.

Method Summary

Modifier and Type	Method	Description
protected DataOutputStream	asParent()	Returns this instance as if it were its parent type.
static DataOutputStream.Builder<? extends DataOutputStream.Builder>	builder()	A DataOutputStream.Builder object constructs a DataOutputStream with the specified properties.
DataStreamByteOrder	getByteOrder()	Gets the byte order for the stream.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the DataOutputStream class
boolean	putByte(byte data, @Nullable Cancellable cancellable)	Puts a byte into the output stream.
boolean	putInt16(short data, @Nullable Cancellable cancellable)	Puts a signed 16-bit integer into the output stream.
boolean	putInt32(int data, @Nullable Cancellable cancellable)	Puts a signed 32-bit integer into the output stream.
boolean	putInt64(long data, @Nullable Cancellable cancellable)	Puts a signed 64-bit integer into the stream.
boolean	putString(String str, @Nullable Cancellable cancellable)	Puts a string into the output stream.
boolean	putUint16(short data, @Nullable Cancellable cancellable)	Puts an unsigned 16-bit integer into the output stream.
boolean	putUint32(int data, @Nullable Cancellable cancellable)	Puts an unsigned 32-bit integer into the stream.
boolean	putUint64(long data, @Nullable Cancellable cancellable)	Puts an unsigned 64-bit integer into the stream.
void	setByteOrder(DataStreamByteOrder order)	Sets the byte order of the data output stream to order.

Methods inherited from class org.gnome.gio.FilterOutputStream

getBaseStream, getCloseBaseStream, setCloseBaseStream

Methods inherited from class org.gnome.gio.OutputStream

clearPending, close, closeAsync, closeFinish, closeFn, flush, flushAsync, flushFinish, hasPending, isClosed, isClosing, printf, setPending, splice, splice, spliceAsync, spliceAsync, spliceFinish, write, writeAll, writeAllAsync, writeAllFinish, writeAsync, writeBytes, writeBytesAsync, writeBytesFinish, writeFinish, writev, writevAll, writevAllAsync, writevAllFinish, writevAsync, writevFinish

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

DataOutputStream

public DataOutputStream(MemorySegment address)

Create a DataOutputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DataOutputStream

public DataOutputStream(OutputStream baseStream)

Creates a new data output stream for baseStream.

Parameters:

baseStream - a GOutputStream.

DataOutputStream

public DataOutputStream()

Creates a new DataOutputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DataOutputStream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected DataOutputStream 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 FilterOutputStream

getByteOrder

public DataStreamByteOrder getByteOrder()

Gets the byte order for the stream.

Returns:

the GDataStreamByteOrder for the stream.

putByte

public boolean putByte(byte data,
 @Nullable Cancellable cancellable)
                throws GErrorException

Puts a byte into the output stream.

Parameters:

data - a guchar.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putInt16

public boolean putInt16(short data,
 @Nullable Cancellable cancellable)
                 throws GErrorException

Puts a signed 16-bit integer into the output stream.

Parameters:

data - a gint16.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putInt32

public boolean putInt32(int data,
 @Nullable Cancellable cancellable)
                 throws GErrorException

Puts a signed 32-bit integer into the output stream.

Parameters:

data - a gint32.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putInt64

public boolean putInt64(long data,
 @Nullable Cancellable cancellable)
                 throws GErrorException

Puts a signed 64-bit integer into the stream.

Parameters:

data - a gint64.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putString

public boolean putString(String str,
 @Nullable Cancellable cancellable)
                  throws GErrorException

Puts a string into the output stream.

Parameters:

str - a string.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if string was successfully added to the stream.

Throws:

GErrorException - see GError

putUint16

public boolean putUint16(short data,
 @Nullable Cancellable cancellable)
                  throws GErrorException

Puts an unsigned 16-bit integer into the output stream.

Parameters:

data - a guint16.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putUint32

public boolean putUint32(int data,
 @Nullable Cancellable cancellable)
                  throws GErrorException

Puts an unsigned 32-bit integer into the stream.

Parameters:

data - a guint32.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

putUint64

public boolean putUint64(long data,
 @Nullable Cancellable cancellable)
                  throws GErrorException

Puts an unsigned 64-bit integer into the stream.

Parameters:

data - a guint64.

cancellable - optional GCancellable object, null to ignore.

Returns:

true if data was successfully added to the stream.

Throws:

GErrorException - see GError

setByteOrder

public void setByteOrder(DataStreamByteOrder order)

Sets the byte order of the data output stream to order.

Parameters:

order - a GDataStreamByteOrder.

builder

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

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

Returns:

the builder object