001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.io.wrappers;
031
032import java.io.DataInput;
033import java.io.IOException;
034import java.util.List;
035
036import org.openimaj.io.ReadableBinary;
037
038/**
039 * A wrapper for {@link List} that is readable.
040 *
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 *
043 * @param <V>
044 *            The type of the elements of the list.
045 */
046public abstract class ReadableArrayBinary<V> implements ReadableBinary {
047        /**
048         * The underlying list
049         */
050        public V[] value;
051
052        /**
053         * Construct with a backing list
054         * 
055         * @param list
056         *            the backing list
057         */
058        public ReadableArrayBinary(V[] list) {
059                this.value = list;
060        }
061
062        @Override
063        public void readBinary(DataInput in) throws IOException {
064
065                final int sz = in.readInt();
066                if (this.value == null)
067                        this.value = createEmpty(sz);
068
069                for (int i = 0; i < sz; i++) {
070                        value[i] = readValue(in);
071                }
072        }
073
074        protected abstract V readValue(DataInput in) throws IOException;
075
076        protected abstract V[] createEmpty(int sz) throws IOException;
077
078        @Override
079        public byte[] binaryHeader() {
080                return value.getClass().getName().getBytes();
081        }
082}