1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
/**
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2022 Gothel Software e.K.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.jau.io;
/**
* Supporting std::basic_ios's iostate functionality for all ByteInStream implementations.
*/
public interface IOStateFunc {
/** Clears state flags by assignment to the given value. */
void clear(final IOState state);
/**
* 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.
*/
IOState rdState();
/** Sets state flags, by keeping its previous bits. */
void setState(final IOState state);
/** Checks if no error nor eof() has occurred i.e. I/O operations are available. */
boolean good();
/** Checks if end-of-file has been reached. */
boolean eof();
/** Checks if an error has occurred. */
boolean fail();
/** Checks if a non-recoverable error has occurred. */
boolean bad();
}
|
