001/*
002 * BridJ - Dynamic and blazing-fast native interop for Java.
003 * http://bridj.googlecode.com/
004 *
005 * Copyright (c) 2010-2013, Olivier Chafik (http://ochafik.com/)
006 * All rights reserved.
007 *
008 * Redistribution and use in source and binary forms, with or without
009 * modification, are permitted provided that the following conditions are met:
010 * 
011 *     * Redistributions of source code must retain the above copyright
012 *       notice, this list of conditions and the following disclaimer.
013 *     * Redistributions in binary form must reproduce the above copyright
014 *       notice, this list of conditions and the following disclaimer in the
015 *       documentation and/or other materials provided with the distribution.
016 *     * Neither the name of Olivier Chafik nor the
017 *       names of its contributors may be used to endorse or promote products
018 *       derived from this software without specific prior written permission.
019 * 
020 * THIS SOFTWARE IS PROVIDED BY OLIVIER CHAFIK AND CONTRIBUTORS ``AS IS'' AND ANY
021 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
024 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031package org.bridj;
032
033import java.util.RandomAccess;
034import java.util.ArrayList;
035import java.util.Collection;
036import java.util.Collections;
037import java.util.Iterator;
038import java.util.List;
039import java.util.ListIterator;
040import org.bridj.cpp.std.vector;
041import static org.bridj.Pointer.*;
042
043/**
044 * Interface for lists that use a native storage.<br>
045 * The only method added to this interface {@link NativeList#getPointer()}
046 * returns a pointer to this list, which is does not necessarily point to the
047 * first element of the list (it depends on the list's implementation : for
048 * instance {@link vector}.getPointer() will return a pointer to the vector
049 * structure's pointer, while a list created out of a pointer through {@link Pointer#asList()
050 * } will return their storage pointer)
051 *
052 * @author ochafik
053 */
054public interface NativeList<T> extends List<T> {
055
056    /**
057     * Returns a pointer to this list, which is does not necessarily point to
058     * the first element of the list.<br>
059     * The semantics of the returned pointer depends on the list's
060     * implementation : for instance {@link vector}.getPointer() will return a
061     * pointer to the vector structure's pointer, while a list created out of a
062     * pointer through {@link Pointer#asList() } will return their storage
063     * pointer)
064     */
065    public Pointer<?> getPointer();
066}