/////////////////////////////////////////////////////////////////////////////// // Copyright (c) 2001, Eric D. Friedman All Rights Reserved. // Copyright (c) 2009, Rob Eden All Rights Reserved. // Copyright (c) 2009, Jeff Randall All Rights Reserved. // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this program; if not, write to the Free Software // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. /////////////////////////////////////////////////////////////////////////////// package gnu.trove; ////////////////////////////////////////////////// // THIS IS A GENERATED CLASS. DO NOT HAND EDIT! // ////////////////////////////////////////////////// import gnu.trove.iterator.TIntIterator; import gnu.trove.procedure.TIntProcedure; import java.util.Collection; import java.io.Serializable; /** * An interface that mimics the Collection interface. * * @author Eric D. Friedman * @author Rob Eden * @author Jeff Randall * @version $Id: _E_Collection.template,v 1.1.2.2 2009/09/15 02:38:30 upholderoftruth Exp $ */ public interface TIntCollection extends Serializable { /** * Returns the value that is used to represent null. The default * value is generally zero, but can be changed during construction * of the collection. * * @return the value that represents null */ int getNoEntryValue(); /** * Returns the number of elements in this collection (its cardinality). If this * collection contains more than Integer.MAX_VALUE elements, returns * Integer.MAX_VALUE. * * @return the number of elements in this collection (its cardinality) */ int size(); /** * Returns true if this collection contains no elements. * * @return true if this collection contains no elements */ boolean isEmpty(); /** * Returns true if this collection contains the specified element. * * @param entry an int value * @return true if the collection contains the specified element. */ boolean contains( int entry ); /** * Creates an iterator over the values of the collection. The iterator * supports element deletion. * * @return an TIntIterator value */ TIntIterator iterator(); /** * Returns an array containing all of the elements in this collection. * If this collection makes any guarantees as to what order its elements * are returned by its iterator, this method must return the * elements in the same order. * *

The returned array will be "safe" in that no references to it * are maintained by this collection. (In other words, this method must * allocate a new array even if this collection is backed by an array). * The caller is thus free to modify the returned array. * *

This method acts as bridge between array-based and collection-based * APIs. * * @return an array containing all the elements in this collection */ int[] toArray(); /** * Returns an array containing elements in this collection. * *

If this collection fits in the specified array with room to spare * (i.e., the array has more elements than this collection), the element in * the array immediately following the end of the collection is collection to * {@link #getNoEntryValue()}. (This is useful in determining * the length of this collection only if the caller knows that this * collection does not contain any elements representing null.) * *

If the native array is smaller than the collection size, * the array will be filled with elements in Iterator order * until it is full and exclude the remainder. * *

If this collection makes any guarantees as to what order its elements * are returned by its iterator, this method must return the elements * in the same order. * * @param dest the array into which the elements of this collection are to be * stored. * @return an int[] containing all the elements in this collection * @throws NullPointerException if the specified array is null */ int[] toArray( int[] dest ); /** * Inserts a value into the collection. * * @param entry a int value * @return true if the collection was modified by the add operation */ boolean add( int entry ); /** * Removes entry from the collection. * * @param entry an int value * @return true if the collection was modified by the remove operation. */ boolean remove( int entry ); /** * Tests the collection to determine if all of the elements in * collection are present. * * @param collection a Collection value * @return true if all elements were present in the collection. */ boolean containsAll( Collection collection ); /** * Tests the collection to determine if all of the elements in * TIntCollection are present. * * @param collection a TIntCollection value * @return true if all elements were present in the collection. */ boolean containsAll( TIntCollection collection ); /** * Tests the collection to determine if all of the elements in * array are present. * * @param array as array of int primitives. * @return true if all elements were present in the collection. */ boolean containsAll( int[] array ); /** * Adds all of the elements in collection to the collection. * * @param collection a Collection value * @return true if the collection was modified by the add all operation. */ boolean addAll( Collection collection ); /** * Adds all of the elements in the TIntCollection to the collection. * * @param collection a TIntCollection value * @return true if the collection was modified by the add all operation. */ boolean addAll( TIntCollection collection ); /** * Adds all of the elements in the array to the collection. * * @param array a array of int primitives. * @return true if the collection was modified by the add all operation. */ boolean addAll( int[] array ); /** * Removes any values in the collection which are not contained in * collection. * * @param collection a Collection value * @return true if the collection was modified by the retain all operation */ boolean retainAll( Collection collection ); /** * Removes any values in the collection which are not contained in * TIntCollection. * * @param collection a TIntCollection value * @return true if the collection was modified by the retain all operation */ boolean retainAll( TIntCollection collection ); /** * Removes any values in the collection which are not contained in * array. * * @param array an array of int primitives. * @return true if the collection was modified by the retain all operation */ boolean retainAll( int[] array ); /** * Removes all of the elements in collection from the collection. * * @param collection a Collection value * @return true if the collection was modified by the remove all operation. */ boolean removeAll( Collection collection ); /** * Removes all of the elements in TIntCollection from the collection. * * @param collection a TIntCollection value * @return true if the collection was modified by the remove all operation. */ boolean removeAll( TIntCollection collection ); /** * Removes all of the elements in array from the collection. * * @param array an array of int primitives. * @return true if the collection was modified by the remove all operation. */ boolean removeAll( int[] array ); /** * Empties the collection. */ void clear(); /** * Executes procedure for each element in the collection. * * @param procedure a TIntProcedure value * @return false if the loop over the collection terminated because * the procedure returned false for some value. */ boolean forEach( TIntProcedure procedure ); // Comparison and hashing /** * Compares the specified object with this collection for equality. Returns * true if the specified object is also a collection, the two collection * have the same size, and every member of the specified collection is * contained in this collection (or equivalently, every member of this collection is * contained in the specified collection). This definition ensures that the * equals method works properly across different implementations of the * collection interface. * * @param o object to be compared for equality with this collection * @return true if the specified object is equal to this collection */ @Override boolean equals( Object o ); /** * Returns the hash code value for this collection. The hash code of a collection is * defined to be the sum of the hash codes of the elements in the collection. * This ensures that s1.equals(s2) implies that * s1.hashCode()==s2.hashCode() for any two collection s1 * and s2, as required by the general contract of * {@link Object#hashCode}. * * @return the hash code value for this collection * @see Object#equals(Object) * @see Collection#equals(Object) */ @Override int hashCode(); } // TIntCollection