AbstractLongCollection (long-common 8.5.13-SNAPSHOT API)

java.lang.Object
- java.util.AbstractCollection<java.lang.Long>
- - it.unimi.dsi.fastutil.longs.AbstractLongCollection

All Implemented Interfaces:

LongCollection, LongIterable, java.lang.Iterable<java.lang.Long>, java.util.Collection<java.lang.Long>

Direct Known Subclasses:

AbstractLongList, LongCollections.EmptyCollection, LongCollections.IterableCollection
```
public abstract class AbstractLongCollection
extends java.util.AbstractCollection<java.lang.Long>
implements LongCollection
```
An abstract class providing basic methods for collections implementing a type-specific interface.
In particular, this class provide iterator(), add(), remove(Object) and contains(Object) methods that just call the type-specific counterpart.
Warning: Because of a name clash between the list and collection interfaces the type-specific deletion method of a type-specific abstract collection is rem(), rather then remove(). A subclass must thus override rem(), rather than remove(), to make all inherited methods work properly.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractLongCollection()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractLongCollection()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(long k)` Ensures that this collection contains the specified element (optional operation).
`boolean`	`add(java.lang.Long key)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`addAll(java.util.Collection<? extends java.lang.Long> c)`
`boolean`	`addAll(LongCollection c)` Adds all elements of the given type-specific collection to this collection.
`boolean`	`contains(long k)` Returns `true` if this collection contains the specified element.
`boolean`	`contains(java.lang.Object key)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`containsAll(java.util.Collection<?> c)`
`boolean`	`containsAll(LongCollection c)` Checks whether this collection contains all elements from the given type-specific collection.
`void`	`forEach(it.unimi.dsi.fastutil.longs.LongConsumer action)` Performs the given action for each element of this type-specific `Iterable` until all elements have been processed or the action throws an exception.
`abstract it.unimi.dsi.fastutil.longs.LongIterator`	`iterator()` Returns a type-specific iterator on the elements of this collection.
`boolean`	`rem(long k)` Removes a single instance of the specified element from this collection, if it is present (optional operation).
`boolean`	`remove(java.lang.Object key)` Deprecated. Please use the corresponding type-specific method instead.
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`removeAll(LongCollection c)` Remove from this collection all elements in the given type-specific collection.
`boolean`	`removeIf(LongPredicate filter)` Remove from this collection all elements which satisfy the given predicate.
`boolean`	`retainAll(java.util.Collection<?> c)`
`boolean`	`retainAll(LongCollection c)` Retains in this collection only elements from the given type-specific collection.
`long[]`	`toArray(long[] a)` Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
`long[]`	`toLongArray()` Returns a primitive type array containing the items of this collection.
`long[]`	`toLongArray(long[] a)` Deprecated. Please use `toArray()` instead—this method is redundant and will be removed in the future.
`java.lang.String`	`toString()`

Methods inherited from class java.util.AbstractCollection
clear, isEmpty, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongCollection
longIterator, longParallelStream, longSpliterator, longStream, parallelStream, removeIf, removeIf, spliterator, stream

Methods inherited from interface java.util.Collection
clear, equals, hashCode, isEmpty, size, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongIterable
forEach, forEach

- Constructor Detail
  - AbstractLongCollection
```
protected AbstractLongCollection()
```
- Method Detail
  - iterator
```
public abstract it.unimi.dsi.fastutil.longs.LongIterator iterator()
```
    Description copied from interface: LongCollection
    
    Returns a type-specific iterator on the elements of this collection.
    
    Specified by:
    
    iterator in interface LongCollection
    
    Specified by:
    
    iterator in interface LongIterable
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Long>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Long>
    
    Specified by:
    
    iterator in class java.util.AbstractCollection<java.lang.Long>
    
    Returns:
    
    a type-specific iterator on the elements of this collection.
    
    See Also:
    
    Iterable.iterator()
  - add
```
public boolean add(long k)
```
    Ensures that this collection contains the specified element (optional operation).
    
    Specified by:
    
    add in interface LongCollection
    
    See Also:
    
    Collection.add(Object)
  - contains
```
public boolean contains(long k)
```
    Returns true if this collection contains the specified element.
    
    Specified by:
    
    contains in interface LongCollection
    
    See Also:
    
    Collection.contains(Object)
  - rem
```
public boolean rem(long k)
```
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().
    
    Specified by:
    
    rem in interface LongCollection
    
    See Also:
    
    Collection.remove(Object)
  - add
```
@Deprecated
public boolean add(java.lang.Long key)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    add in interface LongCollection
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    add in class java.util.AbstractCollection<java.lang.Long>
  - contains
```
@Deprecated
public boolean contains(java.lang.Object key)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    contains in interface LongCollection
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<java.lang.Long>
  - remove
```
@Deprecated
public boolean remove(java.lang.Object key)
```
    Deprecated. Please use the corresponding type-specific method instead.
    
    Specified by:
    
    remove in interface LongCollection
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<java.lang.Long>
  - toArray
```
public long[] toArray(long[] a)
```
    Description copied from interface: LongCollection
    
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
    Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.
    
    Specified by:
    
    toArray in interface LongCollection
    
    Parameters:
    
    a - if this array is big enough, it will be used to store this collection.
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray(Object[])
  - toLongArray
```
public long[] toLongArray()
```
    Description copied from interface: LongCollection
    
    Returns a primitive type array containing the items of this collection.
    
    Specified by:
    
    toLongArray in interface LongCollection
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray()
  - toLongArray
```
@Deprecated
public long[] toLongArray(long[] a)
```
    Deprecated. Please use toArray() instead—this method is redundant and will be removed in the future.
    
    Returns a primitive type array containing the items of this collection.
    Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.
    
    Specified by:
    
    toLongArray in interface LongCollection
    
    Parameters:
    
    a - if this array is big enough, it will be used to store this collection.
    
    Returns:
    
    a primitive type array containing the items of this collection.
    
    See Also:
    
    Collection.toArray(Object[])
  - forEach
```
public final void forEach(it.unimi.dsi.fastutil.longs.LongConsumer action)
```
    Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
    WARNING: Overriding this method is almost always a mistake, as this overload only exists to disambiguate. Instead, override the forEach() overload that uses the JDK's primitive consumer type (e.g. IntConsumer).
    If Java supported final default methods, this would be one, but sadly it does not.
    If you checked and are overriding the version with java.util.function.XConsumer, and still see this warning, then your IDE is incorrectly conflating this method with the proper method to override, and you can safely ignore this message.
    
    Specified by:
    
    forEach in interface LongIterable
    
    Parameters:
    
    action - the action to be performed for each element.
    
    See Also:
    
    Iterable.forEach(java.util.function.Consumer)
  - removeIf
```
public final boolean removeIf(LongPredicate filter)
```
    Remove from this collection all elements which satisfy the given predicate.
    WARNING: Overriding this method is almost always a mistake, as this overload only exists to disambiguate. Instead, override the removeIf() overload that uses the JDK's primitive predicate type (e.g. IntPredicate).
    If Java supported final default methods, this would be one, but sadly it does not.
    If you checked and are overriding the version with java.util.function.XPredicate, and still see this warning, then your IDE is incorrectly conflating this method with the proper method to override, and you can safely ignore this message.
    
    Specified by:
    
    removeIf in interface LongCollection
    
    Parameters:
    
    filter - a predicate which returns true for elements to be removed.
    
    Returns:
    
    true if any elements were removed.
    
    See Also:
    
    Collection.removeIf(java.util.function.Predicate)
  - addAll
```
public boolean addAll(LongCollection c)
```
    Description copied from interface: LongCollection
    
    Adds all elements of the given type-specific collection to this collection.
    
    Specified by:
    
    addAll in interface LongCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.addAll(Collection)
  - addAll
```
public boolean addAll(java.util.Collection<? extends java.lang.Long> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    addAll in class java.util.AbstractCollection<java.lang.Long>
  - containsAll
```
public boolean containsAll(LongCollection c)
```
    Description copied from interface: LongCollection
    
    Checks whether this collection contains all elements from the given type-specific collection.
    
    Specified by:
    
    containsAll in interface LongCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection contains all elements of the argument.
    
    See Also:
    
    Collection.containsAll(Collection)
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    containsAll in class java.util.AbstractCollection<java.lang.Long>
  - removeAll
```
public boolean removeAll(LongCollection c)
```
    Description copied from interface: LongCollection
    
    Remove from this collection all elements in the given type-specific collection.
    
    Specified by:
    
    removeAll in interface LongCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.removeAll(Collection)
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    removeAll in class java.util.AbstractCollection<java.lang.Long>
  - retainAll
```
public boolean retainAll(LongCollection c)
```
    Description copied from interface: LongCollection
    
    Retains in this collection only elements from the given type-specific collection.
    
    Specified by:
    
    retainAll in interface LongCollection
    
    Parameters:
    
    c - a type-specific collection.
    
    Returns:
    
    true if this collection changed as a result of the call.
    
    See Also:
    
    Collection.retainAll(Collection)
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<java.lang.Long>
    
    Overrides:
    
    retainAll in class java.util.AbstractCollection<java.lang.Long>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.util.AbstractCollection<java.lang.Long>

Class AbstractLongCollection

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongCollection

Methods inherited from interface java.util.Collection

Methods inherited from interface it.unimi.dsi.fastutil.longs.LongIterable

Constructor Detail

AbstractLongCollection

Method Detail

iterator

add

contains

rem

add

contains

remove

toArray

toLongArray

toLongArray

forEach

removeIf

addAll

addAll

containsAll

containsAll

removeAll

removeAll

retainAll

retainAll

toString