Class AbstractByteCollection
- java.lang.Object
-
- java.util.AbstractCollection<Byte>
-
- it.unimi.dsi.fastutil.bytes.AbstractByteCollection
-
- All Implemented Interfaces:
ByteCollection
,ByteIterable
,Iterable<Byte>
,Collection<Byte>
- Direct Known Subclasses:
AbstractByteBigList
,AbstractByteList
,AbstractByteSet
,ByteCollections.EmptyCollection
,ByteCollections.IterableCollection
public abstract class AbstractByteCollection extends AbstractCollection<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)
andcontains(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 thenremove()
. A subclass must thus overriderem()
, rather thanremove()
, to make all inherited methods work properly.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(byte k)
Ensures that this collection contains the specified element (optional operation).boolean
add(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
contains(byte k)
Returnstrue
if this collection contains the specified element.boolean
contains(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.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(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
retainAll(ByteCollection c)
Retains in this collection only elements from the given type-specific collection.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 usetoArray()
instead—this method is redundant and will be removed in the future.String
toString()
-
Methods inherited from class java.util.AbstractCollection
addAll, clear, containsAll, isEmpty, removeAll, retainAll, 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
removeIf, removeIf
-
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable
forEach, forEach
-
Methods inherited from interface java.util.Collection
addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, spliterator, stream, toArray, toArray, toArray
-
-
-
-
Method Detail
-
iterator
public abstract ByteIterator iterator()
Description copied from interface:ByteCollection
Returns a type-specific iterator on the elements of this collection.Note that this specification strengthens the one given in
Iterable.iterator()
, which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extendsCollection
.- Specified by:
iterator
in interfaceByteCollection
- Specified by:
iterator
in interfaceByteIterable
- Specified by:
iterator
in interfaceCollection<Byte>
- Specified by:
iterator
in interfaceIterable<Byte>
- Specified by:
iterator
in classAbstractCollection<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).This implementation always throws an
UnsupportedOperationException
.- Specified by:
add
in interfaceByteCollection
- See Also:
Collection.add(Object)
-
contains
public boolean contains(byte k)
Returnstrue
if this collection contains the specified element.This implementation iterates over the elements in the collection, looking for the specified element.
- Specified by:
contains
in interfaceByteCollection
- See Also:
Collection.contains(Object)
-
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 theList
interface forces us to use a distinguished name. For simplicity, the set interfaces reinstatesremove()
.This implementation iterates over the elements in the collection, looking for the specified element and tries to remove it.
- Specified by:
rem
in interfaceByteCollection
- See Also:
Collection.remove(Object)
-
add
@Deprecated public boolean add(Byte key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
add
in interfaceByteCollection
- Specified by:
add
in interfaceCollection<Byte>
- Overrides:
add
in classAbstractCollection<Byte>
-
contains
@Deprecated public boolean contains(Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
contains
in interfaceByteCollection
- Specified by:
contains
in interfaceCollection<Byte>
- Overrides:
contains
in classAbstractCollection<Byte>
-
remove
@Deprecated public boolean remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
remove
in interfaceByteCollection
- Specified by:
remove
in interfaceCollection<Byte>
- Overrides:
remove
in classAbstractCollection<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 interfaceByteCollection
- 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 interfaceByteCollection
- Returns:
- a primitive type array containing the items of this collection.
- See Also:
Collection.toArray()
-
toByteArray
@Deprecated public byte[] toByteArray(byte[] a)
Deprecated.Please usetoArray()
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 interfaceByteCollection
- 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 interfaceByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
Collection.addAll(Collection)
-
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 interfaceByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection contains all elements of the argument.- See Also:
Collection.containsAll(Collection)
-
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 interfaceByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
Collection.removeAll(Collection)
-
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 interfaceByteCollection
- Parameters:
c
- a type-specific collection.- Returns:
true
if this collection changed as a result of the call.- See Also:
Collection.retainAll(Collection)
-
toString
public String toString()
- Overrides:
toString
in classAbstractCollection<Byte>
-
-