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 package org.apache.commons.io.input;
18
19 import java.io.ByteArrayInputStream;
20 import java.io.IOException;
21 import java.io.InputStream;
22
23 /**
24 * This is an alternative to {@link ByteArrayInputStream}
25 * which removes the synchronization overhead for non-concurrent
26 * access; as such this class is not thread-safe.
27 *
28 * Proxy stream that prevents the underlying input stream from being marked/reset.
29 * <p>
30 * This class is typically used in cases where an input stream that supports
31 * marking needs to be passed to a component that wants to explicitly mark
32 * the stream, but it is not desirable to allow marking of the stream.
33 * </p>
34 *
35 * @since 2.8.0
36 */
37 public class MarkShieldInputStream extends ProxyInputStream {
38
39 /**
40 * Constructs a proxy that shields the given input stream from being
41 * marked or rest.
42 *
43 * @param in underlying input stream
44 */
45 public MarkShieldInputStream(final InputStream in) {
46 super(in);
47 }
48
49 @SuppressWarnings("sync-override")
50 @Override
51 public void mark(final int readLimit) {
52 // no-op
53 }
54
55 @Override
56 public boolean markSupported() {
57 return false;
58 }
59
60 @SuppressWarnings("sync-override")
61 @Override
62 public void reset() throws IOException {
63 throw UnsupportedOperationExceptions.reset();
64 }
65 }