/**
 * Copyright 2010-2011 Nicholas Blair, Eric Dalquist
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.ehcache.annotations.key;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;

/**
 * Composite interface that denotes a {@link Serializable} {@link List} that is read only. None of the modification
 * methods will work on this list.
 * 
 * @author Eric Dalquist
 * @version $Revision: 656 $
 */
public class ReadOnlyList<E> implements List<E>, Serializable {
    private static final long serialVersionUID = 1L;
    
    private final List<E> readOnlyDelegate;
    private int hashCodeCache;

    public ReadOnlyList(List<E> readOnlyDelegate) {
        this.readOnlyDelegate = Collections.unmodifiableList(readOnlyDelegate);
    }

    public boolean add(E e) {
        return readOnlyDelegate.add(e);
    }

    public void add(int index, E element) {
        readOnlyDelegate.add(index, element);
    }

    public boolean addAll(Collection<? extends E> c) {
        return readOnlyDelegate.addAll(c);
    }

    public boolean addAll(int index, Collection<? extends E> c) {
        return readOnlyDelegate.addAll(index, c);
    }

    public void clear() {
        readOnlyDelegate.clear();
    }

    public boolean contains(Object o) {
        return readOnlyDelegate.contains(o);
    }

    public boolean containsAll(Collection<?> c) {
        return readOnlyDelegate.containsAll(c);
    }

    @Override
    public boolean equals(Object o) {
        return readOnlyDelegate.equals(o);
    }

    public E get(int index) {
        return readOnlyDelegate.get(index);
    }

    @Override
    public int hashCode() {
        int h = this.hashCodeCache;
        if (h == 0) {
            h = readOnlyDelegate.hashCode();
            this.hashCodeCache = h;
        }
        return h;
    }

    public int indexOf(Object o) {
        return readOnlyDelegate.indexOf(o);
    }

    public boolean isEmpty() {
        return readOnlyDelegate.isEmpty();
    }

    public Iterator<E> iterator() {
        return readOnlyDelegate.iterator();
    }

    public int lastIndexOf(Object o) {
        return readOnlyDelegate.lastIndexOf(o);
    }

    public ListIterator<E> listIterator() {
        return readOnlyDelegate.listIterator();
    }

    public ListIterator<E> listIterator(int index) {
        return readOnlyDelegate.listIterator(index);
    }

    public E remove(int index) {
        return readOnlyDelegate.remove(index);
    }

    public boolean remove(Object o) {
        return readOnlyDelegate.remove(o);
    }

    public boolean removeAll(Collection<?> c) {
        return readOnlyDelegate.removeAll(c);
    }

    public boolean retainAll(Collection<?> c) {
        return readOnlyDelegate.retainAll(c);
    }

    public E set(int index, E element) {
        return readOnlyDelegate.set(index, element);
    }

    public int size() {
        return readOnlyDelegate.size();
    }

    public List<E> subList(int fromIndex, int toIndex) {
        return readOnlyDelegate.subList(fromIndex, toIndex);
    }

    public Object[] toArray() {
        return readOnlyDelegate.toArray();
    }

    public <T> T[] toArray(T[] a) {
        return readOnlyDelegate.toArray(a);
    }

    @Override
    public String toString() {
        return readOnlyDelegate.toString();
    }
}