Package org.javagi.gio

Interface AutoCloseable

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BufferedInputStream, BufferedOutputStream, ConverterInputStream, ConverterOutputStream, DataInputStream, DataOutputStream, FileInputStream, FileIOStream, FileOutputStream, FilterInputStream, FilterInputStream.FilterInputStream$Impl, FilterOutputStream, FilterOutputStream.FilterOutputStream$Impl, InputStream, InputStream.InputStream$Impl, IOStream, IOStream.IOStream$Impl, MemoryInputStream, MemoryOutputStream, MultipartInputStream, OutputStream, OutputStream.OutputStream$Impl, PollableInputStream.PollableInputStream$Impl, PollableOutputStream.PollableOutputStream$Impl, SimpleIOStream, SocketConnection, TcpConnection, TcpWrapperConnection, TlsClientConnection.TlsClientConnection$Impl, TlsConnection, TlsConnection.TlsConnection$Impl, TlsServerConnection.TlsServerConnection$Impl, UnixConnection

@NullMarked
public interface AutoCloseable
extends AutoCloseable

An AutoCloseable interface for GIO streams.

This interface extends AutoCloseable and implements close() with a default method that calls close(Cancellable). This interface is implemented by GIO streams (IOStream, InputStream and OutputStream) so they become AutoCloseable and can be used in a try-with-resources block.

Method Summary

Modifier and Type	Method	Description
default void	close()	A default implementation of AutoCloseable that calls close(Cancellable).
boolean	close(@Nullable Cancellable cancellable)	The close method that is implemented by GIO streams (IOStream, InputStream and OutputStream).

Method Details

close

default void close()
            throws IOException

A default implementation of AutoCloseable that calls close(Cancellable). The return value of close(Cancellable) is ignored.

Specified by:

close in interface AutoCloseable

Throws:

IOException - An IOException that is wrapped around the GErrorException that is thrown by close(Cancellable).

close

boolean close(@Nullable Cancellable cancellable)
       throws GErrorException

The close method that is implemented by GIO streams (IOStream, InputStream and OutputStream).

Parameters:

cancellable - optional Cancellable object, null to ignore

Returns:

true on success, false on failure

Throws:

GErrorException - See GError