BooleanCollection (Joda primitives 1.0 API)

All Superinterfaces:

BooleanIterable, Collection<Boolean>, Iterable<Boolean>, PrimitiveCollectable<Boolean>, PrimitiveCollection<Boolean>

All Known Subinterfaces:

BooleanList

All Known Implementing Classes:

AbstractBooleanCollection, AbstractBooleanList, ArrayBooleanCollection, ArrayBooleanList, ImmutableArrayBooleanList
```
public interface BooleanCollection
extends PrimitiveCollection<Boolean>, BooleanIterable
```
Defines a collection of primitive boolean values.
This interface extends Collection allowing seamless integration with other APIs. All Collection methods can be used, using the primitive wrapper class Boolean. However, it will be much more efficient to use the methods defined here.

Since:

1.0

Version:

CODE GENERATED

Author:

Stephen Colebourne, Jason Tiscione

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(boolean value)` Adds a primitive value to this collection (optional operation).
`boolean`	`addAll(boolean[] values)` Adds an array of primitive values to this collection (optional operation).
`boolean`	`addAll(BooleanCollection values)` Adds a collection of primitive values to this collection (optional operation).
`boolean`	`contains(boolean value)` Checks whether this collection contains a specified primitive value.
`boolean`	`containsAll(boolean[] values)` Checks if this collection contains all of the values in the specified array.
`boolean`	`containsAll(BooleanCollection values)` Checks if this collection contains all of the values in the specified collection.
`boolean`	`containsAny(boolean[] values)` Checks if this collection contains any of the values in the specified array.
`boolean`	`containsAny(BooleanCollection coll)` Checks if this collection contains any of the values in the specified collection.
`BooleanIterator`	`iterator()` Gets an iterator over this collection capable of accessing the primitive values.
`boolean`	`removeAll(boolean value)` Removes all occurrences of the specified primitive value from this collection (optional operation).
`boolean`	`removeAll(boolean[] values)` Removes all occurrences from this collection of each primitive in the specified array (optional operation).
`boolean`	`removeAll(BooleanCollection values)` Removes all occurrences from this collection of each primitive in the specified collection (optional operation).
`boolean`	`removeFirst(boolean value)` Removes the first occurrence of the specified primitive value from this collection (optional operation).
`boolean`	`retainAll(boolean[] values)` Retains each element of this collection that is present in the specified array removing all other values (optional operation).
`boolean`	`retainAll(BooleanCollection values)` Retains each element of this collection that is present in the specified collection removing all other values (optional operation).
`boolean[]`	`toBooleanArray()` Gets the elements of this collection as an array.
`boolean[]`	`toBooleanArray(boolean[] array, int startIndex)` Copies the elements of this collection into an array at a specified position.

Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection
containsAny

Methods inherited from interface org.joda.primitives.PrimitiveCollectable
clear, clone, isEmpty, isModifiable, optimize, size

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

- Method Detail
  - iterator
```
BooleanIterator iterator()
```
    Gets an iterator over this collection capable of accessing the primitive values.
    
    Specified by:
    
    iterator in interface BooleanIterable
    
    Specified by:
    
    iterator in interface Collection<Boolean>
    
    Specified by:
    
    iterator in interface Iterable<Boolean>
    
    Returns:
    an iterator over this collection, not null
  - contains
```
boolean contains(boolean value)
```
    Checks whether this collection contains a specified primitive value.
    
    Parameters:
    value - the value to search for
    
    Returns:
    true if the value is found
  - containsAll
```
boolean containsAll(boolean[] values)
```
    Checks if this collection contains all of the values in the specified array. If the specified array is empty, true is returned.
    
    Parameters:
    values - the values to search for, null treated as empty array
    
    Returns:
    true if all of the values are found
  - containsAll
```
boolean containsAll(BooleanCollection values)
```
    Checks if this collection contains all of the values in the specified collection. If the specified collection is empty, true is returned.
    
    Parameters:
    values - the values to search for, null treated as empty collection
    
    Returns:
    true if all of the values are found
  - containsAny
```
boolean containsAny(boolean[] values)
```
    Checks if this collection contains any of the values in the specified array. If the specified array is empty, false is returned.
    
    Parameters:
    values - the values to search for, null treated as empty array
    
    Returns:
    true if at least one of the values is found
  - containsAny
```
boolean containsAny(BooleanCollection coll)
```
    Checks if this collection contains any of the values in the specified collection. If the specified collection is empty, false is returned.
    
    Parameters:
    coll - the values to search for, null treated as empty collection
    
    Returns:
    true if at least one of the values is found
  - toBooleanArray
```
boolean[] toBooleanArray()
```
    Gets the elements of this collection as an array.
    
    Returns:
    a new array containing a copy of the elements of this collection
  - toBooleanArray
```
boolean[] toBooleanArray(boolean[] array,
                       int startIndex)
```
    Copies the elements of this collection into an array at a specified position. Previous values in the array are overwritten.
    If the array specified is null a new array is created. If the array specified is large enough, it will be modified. If the array is not large enough, a new array will be created containing the values from the specified array before the startIndex plus those from this collection.
    
    Parameters:
    array - the array to add the elements to, null creates new array
    startIndex - the position in the array to start setting elements
    
    Returns:
    the array with the populated collection, not null
    
    Throws:
    
    IndexOutOfBoundsException - if the index is negative
  - add
```
boolean add(boolean value)
```
    Adds a primitive value to this collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.
    
    Parameters:
    value - the value to add to this collection
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    IllegalArgumentException - if value is rejected by this collection
    
    UnsupportedOperationException - if not supported by this collection
  - addAll
```
boolean addAll(boolean[] values)
```
    Adds an array of primitive values to this collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.
    
    Parameters:
    values - the values to add to this collection, null treated as empty array
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    IllegalArgumentException - if a value is rejected by this collection
    
    UnsupportedOperationException - if not supported by this collection
  - addAll
```
boolean addAll(BooleanCollection values)
```
    Adds a collection of primitive values to this collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.
    
    Parameters:
    values - the values to add to this collection, null treated as empty collection
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    IllegalArgumentException - if a value is rejected by this collection
    
    UnsupportedOperationException - if not supported by this collection
  - removeFirst
```
boolean removeFirst(boolean value)
```
    Removes the first occurrence of the specified primitive value from this collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    value - the value to remove
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection
  - removeAll
```
boolean removeAll(boolean value)
```
    Removes all occurrences of the specified primitive value from this collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    value - the value to remove
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection
  - removeAll
```
boolean removeAll(boolean[] values)
```
    Removes all occurrences from this collection of each primitive in the specified array (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    values - the values to remove from this collection, null treated as empty array
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection
  - removeAll
```
boolean removeAll(BooleanCollection values)
```
    Removes all occurrences from this collection of each primitive in the specified collection (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    values - the values to remove from this collection, null treated as empty collection
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection
  - retainAll
```
boolean retainAll(boolean[] values)
```
    Retains each element of this collection that is present in the specified array removing all other values (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    values - the values to retain in this collection, null treated as empty array
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection
  - retainAll
```
boolean retainAll(BooleanCollection values)
```
    Retains each element of this collection that is present in the specified collection removing all other values (optional operation).
    This method is optional, throwing an UnsupportedOperationException if the collection cannot be removed from.
    
    Parameters:
    values - the values to retain in this collection, null treated as empty collection
    
    Returns:
    true if this collection was modified by this method call
    
    Throws:
    
    UnsupportedOperationException - if not supported by this collection

Interface BooleanCollection

Method Summary

Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection

Methods inherited from interface org.joda.primitives.PrimitiveCollectable

Methods inherited from interface java.util.Collection

Method Detail

iterator

contains

containsAll

containsAll

containsAny

containsAny

toBooleanArray

toBooleanArray

add

addAll

addAll

removeFirst

removeAll

removeAll

removeAll

retainAll

retainAll