001/*
002 * #%L
003 * Netarchivesuite - common
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023
024package dk.netarkivet.common.utils;
025
026/**
027 * Implements access to an array in a read-only fashion.
028 */
029public class ReadOnlyByteArray {
030
031    private byte[] array;
032
033    /**
034     * Creates a new instance based on the given array.
035     *
036     * @param array Array to provide read-only access to. The array will not be copied by this class.
037     */
038    public ReadOnlyByteArray(byte[] array) {
039        this.array = array;
040    }
041
042    /**
043     * Returns the length of the array.
044     *
045     * @return The length of the array. Always >= 0.
046     */
047    public int length() {
048        return array.length;
049    }
050
051    /**
052     * Gets the element at the given index.
053     *
054     * @param index The index to get the element at.
055     * @return The byte at the given index.
056     * @throws IndexOutOfBoundsException if the index is < 0 or > length()
057     */
058    public byte get(int index) {
059        return array[index];
060    }
061
062}