001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.io.input;
018
019import java.io.InputStream;
020
021/**
022 *
023 * An {@link InputStream} that infinitely repeats provided bytes.
024 * <p>
025 * Closing a <code>InfiniteCircularInputStream</code> has no effect. The methods in
026 * this class can be called after the stream has been closed without generating
027 * an <code>IOException</code>.
028 * </p>
029 * @since 2.6
030 */
031public class InfiniteCircularInputStream extends InputStream {
032
033    final private byte[] repeatedContent;
034    private int position = -1;
035
036    /**
037     * Creates a InfiniteCircularStream from the specified array of chars.
038     *
039     * @param repeatedContent
040     *            Input buffer to be repeated (not copied)
041     */
042    public InfiniteCircularInputStream(final byte[] repeatedContent) {
043        this.repeatedContent = repeatedContent;
044    }
045
046    @Override
047    public int read() {
048        position = (position + 1) % repeatedContent.length;
049        return repeatedContent[position] & 0xff;
050    }
051
052}