View Javadoc
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   *
24   * An {@link InputStream} that infinitely repeats the provided bytes.
25   * <p>
26   * Closing this input stream has no effect. The methods in this class can be called after the stream has been closed
27   * without generating an {@link IOException}.
28   * </p>
29   *
30   * @since 2.6
31   */
32  public class InfiniteCircularInputStream extends CircularInputStream {
33  
34      /**
35       * Constructs an instance from the specified array of bytes.
36       *
37       * @param repeatContent Input buffer to be repeated this buffer is not copied.
38       */
39      public InfiniteCircularInputStream(final byte[] repeatContent) {
40          // A negative number means an infinite target count.
41          super(repeatContent, -1);
42      }
43  
44  }