1 package nom.tam.util;
2
3 /*
4 * #%L
5 * nom.tam FITS library
6 * %%
7 * Copyright (C) 1996 - 2024 nom-tam-fits
8 * %%
9 * This is free and unencumbered software released into the public domain.
10 *
11 * Anyone is free to copy, modify, publish, use, compile, sell, or
12 * distribute this software, either in source code form or as a compiled
13 * binary, for any purpose, commercial or non-commercial, and by any
14 * means.
15 *
16 * In jurisdictions that recognize copyright laws, the author or authors
17 * of this software dedicate any and all copyright interest in the
18 * software to the public domain. We make this dedication for the benefit
19 * of the public at large and to the detriment of our heirs and
20 * successors. We intend this dedication to be an overt act of
21 * relinquishment in perpetuity of all present and future rights to this
22 * software under copyright law.
23 *
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
27 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
28 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
29 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
30 * OTHER DEALINGS IN THE SOFTWARE.
31 * #L%
32 */
33
34 import java.io.IOException;
35 import java.io.InputStream;
36
37 /**
38 * Interface for asic binary input reading functionality.
39 *
40 * @author Attila Kovacs
41 * @since 1.16
42 * @see OutputWriter
43 */
44 public interface InputReader {
45
46 /**
47 * Reads a byte. See the general contract of
48 * {@link java.io.DataInputStream#read()}.
49 *
50 * @return the (unsigned) byte value or -1 if there is nothing left to read.
51 * @throws IOException
52 * if there was an underlying IO error
53 * @see java.io.DataInputStream#read()
54 */
55 int read() throws IOException;
56
57 /**
58 * Reads up to the specified number of bytes into a buffer. See the general
59 * contract of {@link java.io.DataInputStream#read(byte[], int, int)}.
60 *
61 * @param b
62 * the buffer
63 * @param from
64 * the starting buffer index
65 * @param length
66 * the number of bytes to read.
67 * @return the number of bytes actually read, or -1 if there is nothing left
68 * to read.
69 * @throws IOException
70 * if there was an underlying IO error
71 * @see java.io.DataInputStream#read(byte[], int, int)
72 */
73 int read(byte[] b, int from, int length) throws IOException;
74
75 /**
76 * Wraps an input stream with this interface.
77 *
78 * @param i
79 * any input stream
80 * @return the stream wrapped to this interface
81 */
82 static InputReader from(final InputStream i) {
83 return new InputReader() {
84
85 @Override
86 public int read() throws IOException {
87 return i.read();
88 }
89
90 @Override
91 public int read(byte[] b, int from, int length) throws IOException {
92 return i.read(b, from, length);
93 }
94
95 };
96 }
97 }