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