org.jau.io.IOStateFunc Interface Reference

Supporting std::basic_ios's iostate functionality for all ByteInStream implementations. More...

Inheritance diagram for org.jau.io.IOStateFunc:

Collaboration diagram for org.jau.io.IOStateFunc:

Public Member Functions
void	clear (final IOState state)
	Clears state flags by assignment to the given value. More...
IOState	rdState ()
	Returns the current state flags. More...
void	setState (final IOState state)
	Sets state flags, by keeping its previous bits. More...
boolean	good ()
	Checks if no error nor eof() has occurred i.e. More...
boolean	eof ()
	Checks if end-of-file has been reached. More...
boolean	fail ()
	Checks if an error has occurred. More...
boolean	bad ()
	Checks if a non-recoverable error has occurred. More...
boolean	timeout ()
	Checks if a timeout (non-recoverable) has occurred. More...

Detailed Description

Supporting std::basic_ios's iostate functionality for all ByteInStream implementations.

Definition at line 29 of file IOStateFunc.java.

Member Function Documentation

bad()

boolean org.jau.io.IOStateFunc.bad

(

)

Checks if a non-recoverable error has occurred.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

clear()

void org.jau.io.IOStateFunc.clear

(

final IOState

state

)

Clears state flags by assignment to the given value.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

eof()

boolean org.jau.io.IOStateFunc.eof

(

)

Checks if end-of-file has been reached.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

fail()

boolean org.jau.io.IOStateFunc.fail

(

)

Checks if an error has occurred.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

Here is the caller graph for this function:

good()

boolean org.jau.io.IOStateFunc.good

(

)

Checks if no error nor eof() has occurred i.e.

I/O operations are available.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

Here is the caller graph for this function:

rdState()

IOState org.jau.io.IOStateFunc.rdState

(

)

Returns the current state flags.

Method is marked virtual to allow implementations with asynchronous resources to determine or update the current iostate.

Method is used throughout all query members and setstate(), hence they all will use the updated state from a potential override implementation.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

setState()

void org.jau.io.IOStateFunc.setState

(

final IOState

state

)

Sets state flags, by keeping its previous bits.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

timeout()

boolean org.jau.io.IOStateFunc.timeout

(

)

Checks if a timeout (non-recoverable) has occurred.

Implemented in org.jau.io.ByteInStream_Feed, org.jau.io.ByteInStream_File, org.jau.io.ByteInStream_URL, and org.jau.io.ByteOutStream_File.

---

The documentation for this interface was generated from the following file:

• java_jni/org/jau/io/IOStateFunc.java