ByteCollections.SynchronizedCollection (fastutil 8.1.0)

java.lang.Object
- it.unimi.dsi.fastutil.bytes.ByteCollections.SynchronizedCollection

All Implemented Interfaces:

ByteCollection, ByteIterable, Serializable, Iterable<Byte>, Collection<Byte>

Direct Known Subclasses:

ByteBigLists.SynchronizedBigList, ByteLists.SynchronizedList, ByteSets.SynchronizedSet

Enclosing class:

ByteCollections
```
public static class ByteCollections.SynchronizedCollection
extends Object
implements ByteCollection, Serializable
```
A synchronized wrapper class for collections.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(byte k)` Ensures that this collection contains the specified element (optional operation).
`boolean`	`add(Byte k)` Deprecated.
`boolean`	`addAll(ByteCollection c)` Adds all elements of the given type-specific collection to this collection.
`boolean`	`addAll(Collection<? extends Byte> c)` Adds all of the elements in the specified collection to this collection (optional operation).
`void`	`clear()` Removes all of the elements from this collection (optional operation).
`boolean`	`contains(byte k)` Returns `true` if this collection contains the specified element.
`boolean`	`contains(Object k)` Deprecated.
`boolean`	`containsAll(ByteCollection c)` Checks whether this collection contains all elements from the given type-specific collection.
`boolean`	`containsAll(Collection<?> c)` Returns `true` if this collection contains all of the elements in the specified collection.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isEmpty()` Returns `true` if this collection contains no elements.
`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 k)` Deprecated.
`boolean`	`removeAll(ByteCollection c)` Remove from this collection all elements in the given type-specific collection.
`boolean`	`removeAll(Collection<?> c)` Removes all of this collection's elements that are also contained in the specified collection (optional operation).
`boolean`	`retainAll(ByteCollection c)` Retains in this collection only elements from the given type-specific collection.
`boolean`	`retainAll(Collection<?> c)` Retains only the elements in this collection that are contained in the specified collection (optional operation).
`int`	`size()` Returns the number of elements in this collection.
`Object[]`	`toArray()` Returns an array containing all of the elements in this 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.
`<T> T[]`	`toArray(T[] 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.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, spliterator, stream

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

- Method Detail
  - add
```
public boolean add(byte k)
```
    Description copied from interface: ByteCollection
    
    Ensures that this collection contains the specified element (optional operation).
    
    Specified by:
    
    add in interface ByteCollection
    
    See Also:
    
    Collection.add(Object)
  - contains
```
public boolean contains(byte k)
```
    Description copied from interface: ByteCollection
    
    Returns true if this collection contains the specified element.
    
    Specified by:
    
    contains in interface ByteCollection
    
    See Also:
    
    Collection.contains(Object)
  - rem
```
public boolean rem(byte k)
```
    Description copied from interface: ByteCollection
    
    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)
  - size
```
public int size()
```
    Description copied from interface: java.util.Collection
    
    Returns the number of elements in this collection. If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface Collection<Byte>
    
    Returns:
    
    the number of elements in this collection
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: java.util.Collection
    
    Returns true if this collection contains no elements.
    
    Specified by:
    
    isEmpty in interface Collection<Byte>
    
    Returns:
    
    true if this collection contains no elements
  - 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()
  - toArray
```
public Object[] toArray()
```
    Description copied from interface: java.util.Collection
    
    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.
    
    Specified by:
    
    toArray in interface Collection<Byte>
    
    Returns:
    
    an array containing all of the elements in this collection
  - toByteArray
```
@Deprecated
public byte[] toByteArray(byte[] a)
```
    Deprecated.
    
    Description copied from interface: ByteCollection
    
    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[])
  - 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[])
  - 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)
  - 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)
  - 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)
  - 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)
  - add
```
@Deprecated
public boolean add(Byte k)
```
    Deprecated.
    
    Description copied from interface: ByteCollection
    
    Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)
    Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.
    If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.
    
    Specified by:
    
    add in interface ByteCollection
    
    Specified by:
    
    add in interface Collection<Byte>
    
    Parameters:
    
    k - element whose presence in this collection is to be ensured
    
    Returns:
    
    true if this collection changed as a result of the call
  - contains
```
@Deprecated
public boolean contains(Object k)
```
    Deprecated.
    
    Description copied from interface: ByteCollection
    
    Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that (o==null ? e==null : o.equals(e)).
    
    Specified by:
    
    contains in interface ByteCollection
    
    Specified by:
    
    contains in interface Collection<Byte>
    
    Parameters:
    
    k - element whose presence in this collection is to be tested
    
    Returns:
    
    true if this collection contains the specified element
  - remove
```
@Deprecated
public boolean remove(Object k)
```
    Deprecated.
    
    Description copied from interface: ByteCollection
    
    Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).
    
    Specified by:
    
    remove in interface ByteCollection
    
    Specified by:
    
    remove in interface Collection<Byte>
    
    Parameters:
    
    k - element to be removed from this collection, if present
    
    Returns:
    
    true if an element was removed as a result of this call
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Description copied from interface: java.util.Collection
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. If the collection fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of 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 set to null. (This is useful in determining the length of this collection only if the caller knows that this collection does not contain any null elements.)
    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.
    Like the Collection.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.
    Suppose x is a collection known to contain only strings. The following code can be used to dump the collection into a newly allocated array of String:
```
     String[] y = x.toArray(new String[0]);
```
    Note that toArray(new Object[0]) is identical in function to toArray().
    Specified by:
    
    toArray in interface Collection<Byte>
    
    Type Parameters:
    
    T - the runtime type of the array to contain the collection
    
    Parameters:
    
    a - the array into which the elements of this collection are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
    
    Returns:
    
    an array containing all of the elements in this collection
  - iterator
```
public 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 extends Collection.
    
    Specified by:
    
    iterator in interface ByteCollection
    
    Specified by:
    
    iterator in interface ByteIterable
    
    Specified by:
    
    iterator in interface Iterable<Byte>
    
    Specified by:
    
    iterator in interface Collection<Byte>
    
    Returns:
    
    a type-specific iterator on the elements of this collection.
    
    See Also:
    
    Iterable.iterator()
  - addAll
```
public boolean addAll(Collection<? extends Byte> c)
```
    Description copied from interface: java.util.Collection
    
    Adds all of the elements in the specified collection to this collection (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this collection, and this collection is nonempty.)
    
    Specified by:
    
    addAll in interface Collection<Byte>
    
    Parameters:
    
    c - collection containing elements to be added to this collection
    
    Returns:
    
    true if this collection changed as a result of the call
    
    See Also:
    
    Collection.add(Object)
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Description copied from interface: java.util.Collection
    
    Returns true if this collection contains all of the elements in the specified collection.
    
    Specified by:
    
    containsAll in interface Collection<Byte>
    
    Parameters:
    
    c - collection to be checked for containment in this collection
    
    Returns:
    
    true if this collection contains all of the elements in the specified collection
    
    See Also:
    
    Collection.contains(Object)
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Description copied from interface: java.util.Collection
    
    Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.
    
    Specified by:
    
    removeAll in interface Collection<Byte>
    
    Parameters:
    
    c - collection containing elements to be removed from this collection
    
    Returns:
    
    true if this collection changed as a result of the call
    
    See Also:
    
    Collection.remove(Object), Collection.contains(Object)
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Description copied from interface: java.util.Collection
    
    Retains only the elements in this collection that are contained in the specified collection (optional operation). In other words, removes from this collection all of its elements that are not contained in the specified collection.
    
    Specified by:
    
    retainAll in interface Collection<Byte>
    
    Parameters:
    
    c - collection containing elements to be retained in this collection
    
    Returns:
    
    true if this collection changed as a result of the call
    
    See Also:
    
    Collection.remove(Object), Collection.contains(Object)
  - clear
```
public void clear()
```
    Description copied from interface: java.util.Collection
    
    Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.
    
    Specified by:
    
    clear in interface Collection<Byte>
  - toString
```
public String toString()
```
    Description copied from class: java.lang.Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.lang.Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    Specified by:
    
    hashCode in interface Collection<Byte>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: java.lang.Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Specified by:
    
    equals in interface Collection<Byte>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap

Class ByteCollections.SynchronizedCollection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

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

Method Detail

add

contains

rem

size

isEmpty

toByteArray

toArray

toByteArray

toArray

addAll

containsAll

removeAll

retainAll

add

contains

remove

toArray

iterator

addAll

containsAll

removeAll

retainAll

clear

toString

hashCode

equals