All Downloads are FREE. Search and download functionalities are using the official Maven repository.

gnu.trove.TLongCollection Maven / Gradle / Ivy

Go to download

The Trove library provides high speed regular and primitive collections for Java.

There is a newer version: 3.0.3
Show newest version
///////////////////////////////////////////////////////////////////////////////
// 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.TLongIterator;
import gnu.trove.procedure.TLongProcedure;

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 TLongCollection {
	static final long serialVersionUID = 1L;

    /**
     * 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
     */
    long 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 long value
     * @return true if the collection contains the specified element.
     */
    boolean contains( long entry );


    /**
     * Creates an iterator over the values of the collection.  The iterator
     * supports element deletion.
     *
     * @return an TLongIterator value
     */
    TLongIterator 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 */ long[] 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 long[] containing all the elements in this collection * @throws NullPointerException if the specified array is null */ long[] toArray( long[] dest ); /** * Inserts a value into the collection. * * @param entry a long value * @return true if the collection was modified by the add operation */ boolean add( long entry ); /** * Removes entry from the collection. * * @param entry an long value * @return true if the collection was modified by the remove operation. */ boolean remove( long 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 * TLongCollection are present. * * @param collection a TLongCollection value * @return true if all elements were present in the collection. */ boolean containsAll( TLongCollection collection ); /** * Tests the collection to determine if all of the elements in * array are present. * * @param array as array of long primitives. * @return true if all elements were present in the collection. */ boolean containsAll( long[] 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 TLongCollection to the collection. * * @param collection a TLongCollection value * @return true if the collection was modified by the add all operation. */ boolean addAll( TLongCollection collection ); /** * Adds all of the elements in the array to the collection. * * @param array a array of long primitives. * @return true if the collection was modified by the add all operation. */ boolean addAll( long[] 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 * TLongCollection. * * @param collection a TLongCollection value * @return true if the collection was modified by the retain all operation */ boolean retainAll( TLongCollection collection ); /** * Removes any values in the collection which are not contained in * array. * * @param array an array of long primitives. * @return true if the collection was modified by the retain all operation */ boolean retainAll( long[] 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 TLongCollection from the collection. * * @param collection a TLongCollection value * @return true if the collection was modified by the remove all operation. */ boolean removeAll( TLongCollection collection ); /** * Removes all of the elements in array from the collection. * * @param array an array of long primitives. * @return true if the collection was modified by the remove all operation. */ boolean removeAll( long[] array ); /** * Empties the collection. */ void clear(); /** * Executes procedure for each element in the collection. * * @param procedure a TLongProcedure value * @return false if the loop over the collection terminated because * the procedure returned false for some value. */ boolean forEach( TLongProcedure 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 */ 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) */ int hashCode(); } // TLongCollection





© 2015 - 2024 Weber Informatics LLC | Privacy Policy