1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.io.input;
19
20 import java.io.IOException;
21 import java.io.InputStream;
22
23 /**
24 * Abstracts some InputStream operations for implementations in this package.
25 *
26 * @since 2.17.0
27 */
28 public abstract class AbstractInputStream extends InputStream {
29
30 /**
31 * Whether {@link #close()} completed successfully.
32 */
33 private boolean closed;
34
35 /**
36 * Constructs a new instance for subclasses.
37 */
38 public AbstractInputStream() {
39 // empty
40 }
41
42 /**
43 * Checks if this instance is closed and throws an IOException if so.
44 *
45 * @throws IOException if this instance is closed.
46 */
47 void checkOpen() throws IOException {
48 Input.checkOpen(!isClosed());
49 }
50
51 @Override
52 public void close() throws IOException {
53 super.close();
54 closed = true;
55 }
56
57 /**
58 * Tests whether this instance is closed; if {@link #close()} completed successfully.
59 *
60 * @return whether this instance is closed.
61 */
62 public boolean isClosed() {
63 return closed;
64 }
65
66 /**
67 * Sets whether this instance is closed.
68 *
69 * @param closed whether this instance is closed.
70 */
71 public void setClosed(final boolean closed) {
72 this.closed = closed;
73 }
74
75 }