1 /***
2 * Copyright 2006 Joseph M. Ferner
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.fernsroth.easyio;
17
18 import java.io.IOException;
19
20 /***
21 *
22 * @author Joseph M. Ferner (Near Infinity Corporation)
23 */
24 public interface IInputStream {
25
26 /***
27 * read a single byte.
28 * @return the data read.
29 * @throws IOException
30 */
31 int read() throws IOException;
32
33 /***
34 * @param buffer the buffer to put the data in.
35 * @param off the offset into buffer to start reading into.
36 * @param len the length to read.
37 * @return the number of bytes read.
38 * @throws IOException
39 */
40 int read(byte[] buffer, int off, int len) throws IOException;
41
42 /***
43 * @param buffer the buffer to read data into.
44 * @return the number of bytes read.
45 * @throws IOException
46 */
47 int read(byte[] buffer) throws IOException;
48 }