Package it.unimi.dsi.fastutil.bytes

Class AbstractByteCollection

java.lang.Object
java.util.AbstractCollection<java.lang.Byte>
it.unimi.dsi.fastutil.bytes.AbstractByteCollection
All Implemented Interfaces:
ByteCollection, ByteIterable, java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>
Direct Known Subclasses:
AbstractByteBigList, AbstractByteList, AbstractByteSet, ByteCollections.EmptyCollection, ByteCollections.IterableCollection
public abstract class AbstractByteCollection
extends java.util.AbstractCollection<java.lang.Byte>
implements ByteCollection
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.

  • Method Summary

    Modifier and Type Method Description
    boolean add​(byte k)
    Ensures that this collection contains the specified element (optional operation).
    boolean add​(java.lang.Byte key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean addAll​(ByteCollection c)
    Adds all elements of the given type-specific collection to this collection.
    boolean addAll​(java.util.Collection<? extends java.lang.Byte> c)
    boolean contains​(byte 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​(ByteCollection c)
    Checks whether this collection contains all elements from the given type-specific collection.
    boolean containsAll​(java.util.Collection<?> c)
    abstract ByteIterator iterator()
    Returns a type-specific iterator on the elements of this collection.
    boolean rem​(byte 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​(ByteCollection c)
    Remove from this collection all elements in the given type-specific collection.
    boolean removeAll​(java.util.Collection<?> c)
    boolean retainAll​(ByteCollection c)
    Retains in this collection only elements from the given type-specific collection.
    boolean retainAll​(java.util.Collection<?> c)
    byte[] toArray​(byte[] 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.
    byte[] toByteArray()
    Returns a primitive type array containing the items of this collection.
    byte[] toByteArray​(byte[] 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

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection

    intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeIf, removeIf, removeIf, spliterator, stream

    Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable

    forEach, forEach, forEach

    Methods inherited from interface java.util.Collection

    clear, equals, hashCode, isEmpty, size, toArray, toArray, toArray

  • Method Details

    • iterator

      public abstract ByteIterator iterator()
      Description copied from interface: ByteCollection
      Returns a type-specific iterator on the elements of this collection.
      Specified by:
      iterator in interface ByteCollection
      Specified by:
      iterator in interface ByteIterable
      Specified by:
      iterator in interface java.util.Collection<java.lang.Byte>
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Byte>
      Specified by:
      iterator in class java.util.AbstractCollection<java.lang.Byte>
      Returns:
      a type-specific iterator on the elements of this collection.
      See Also:
      Iterable.iterator()

    • add

      public boolean add​(byte k)
      Ensures that this collection contains the specified element (optional operation).
      Specified by:
      add in interface ByteCollection
      See Also:
      Collection.add(Object)
      Implementation Specification:
      This implementation always throws an UnsupportedOperationException.

    • contains

      public boolean contains​(byte k)
      Returns true if this collection contains the specified element.
      Specified by:
      contains in interface ByteCollection
      See Also:
      Collection.contains(Object)
      Implementation Specification:
      This implementation iterates over the elements in the collection, looking for the specified element.

    • rem

      public boolean rem​(byte 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 ByteCollection
      See Also:
      Collection.remove(Object)
      Implementation Specification:
      This implementation iterates over the elements in the collection, looking for the specified element and tries to remove it.

    • add

      @Deprecated public boolean add​(java.lang.Byte key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      add in interface ByteCollection
      Specified by:
      add in interface java.util.Collection<java.lang.Byte>
      Overrides:
      add in class java.util.AbstractCollection<java.lang.Byte>

    • contains

      @Deprecated public boolean contains​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      contains in interface ByteCollection
      Specified by:
      contains in interface java.util.Collection<java.lang.Byte>
      Overrides:
      contains in class java.util.AbstractCollection<java.lang.Byte>

    • remove

      @Deprecated public boolean remove​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      remove in interface ByteCollection
      Specified by:
      remove in interface java.util.Collection<java.lang.Byte>
      Overrides:
      remove in class java.util.AbstractCollection<java.lang.Byte>

    • toArray

      public byte[] toArray​(byte[] a)
      Description copied from interface: ByteCollection
      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 ByteCollection
      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[])

    • toByteArray

      public byte[] toByteArray()
      Description copied from interface: ByteCollection
      Returns a primitive type array containing the items of this collection.
      Specified by:
      toByteArray in interface ByteCollection
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray()

    • toByteArray

      @Deprecated public byte[] toByteArray​(byte[] 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:
      toByteArray in interface ByteCollection
      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[])

    • addAll

      public boolean addAll​(ByteCollection c)
      Description copied from interface: ByteCollection
      Adds all elements of the given type-specific collection to this collection.
      Specified by:
      addAll in interface ByteCollection
      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.Byte> c)
      Specified by:
      addAll in interface java.util.Collection<java.lang.Byte>
      Overrides:
      addAll in class java.util.AbstractCollection<java.lang.Byte>
      Implementation Specification:
      This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from AbstractCollection.

    • containsAll

      public boolean containsAll​(ByteCollection c)
      Description copied from interface: ByteCollection
      Checks whether this collection contains all elements from the given type-specific collection.
      Specified by:
      containsAll in interface ByteCollection
      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.Byte>
      Overrides:
      containsAll in class java.util.AbstractCollection<java.lang.Byte>
      Implementation Specification:
      This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from AbstractCollection.

    • removeAll

      public boolean removeAll​(ByteCollection c)
      Description copied from interface: ByteCollection
      Remove from this collection all elements in the given type-specific collection.
      Specified by:
      removeAll in interface ByteCollection
      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.Byte>
      Overrides:
      removeAll in class java.util.AbstractCollection<java.lang.Byte>
      Implementation Specification:
      This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from AbstractCollection.

    • retainAll

      public boolean retainAll​(ByteCollection c)
      Description copied from interface: ByteCollection
      Retains in this collection only elements from the given type-specific collection.
      Specified by:
      retainAll in interface ByteCollection
      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.Byte>
      Overrides:
      retainAll in class java.util.AbstractCollection<java.lang.Byte>
      Implementation Specification:
      This implementation delegates to the type-specific version if given a type-specific collection, otherwise is uses the implementation from AbstractCollection.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.util.AbstractCollection<java.lang.Byte>