SmallIntSet (Infinispan JavaDoc All 9.2.5.Final API)

java.lang.Object
- org.infinispan.commons.util.SmallIntSet

All Implemented Interfaces:

Iterable<Integer>, Collection<Integer>, Set<Integer>, IntSet
```
public class SmallIntSet
extends Object
implements IntSet
```
Represent a set of integers (e.g. segments) as a BitSet. Memory usage depends on the highest element, as in BitSet and unlike in other collections such as HashSet.

Since:

9.0

Author:

Dan Berindei

Constructor Summary

Constructors
Constructor and Description
`SmallIntSet()`
`SmallIntSet(int initialRange)` Create a new `IntSet` and pre-allocate space for elements `0..initialRange-1`.
`SmallIntSet(IntSet set)`
`SmallIntSet(Set<Integer> set)`
`SmallIntSet(SmallIntSet other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int i)` Add an integer to the set without boxing the parameter.
`boolean`	`add(Integer i)`
`boolean`	`addAll(Collection<? extends Integer> c)`
`boolean`	`addAll(IntSet set)` Adds all ints from the provided set into this one
`int`	`capacity()`
`void`	`clear()`
`boolean`	`contains(int i)` Check if the set contains an integer without boxing the parameter.
`boolean`	`contains(Integer o)`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`containsAll(IntSet set)` Whether this set contains all ints in the given IntSet
`boolean`	`equals(Object o)`
`static SmallIntSet`	`from(Set<Integer> set)` Either converts the given set to an IntSet if it is one or creates a new IntSet and copies the contents
`int`	`hashCode()`
`IntStream`	`intStream()` A stream of ints representing the data in this set
`boolean`	`isEmpty()`
`PrimitiveIterator.OfInt`	`iterator()` A primtive iterator that allows iteration over the int values.
`static SmallIntSet`	`of(int... elements)`
`static SmallIntSet`	`of(int i1)`
`static SmallIntSet`	`of(int i1, int i2)`
`static SmallIntSet`	`of(int i1, int i2, int i3)`
`static SmallIntSet`	`of(PrimitiveIterator.OfInt iterator)`
`static SmallIntSet`	`readFrom(ObjectInput input)`
`boolean`	`remove(int i)` Remove an integer from the set without boxing.
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`removeAll(IntSet set)` Removes all ints from this IntSet that are in the provided IntSet
`boolean`	`retainAll(Collection<?> c)`
`boolean`	`retainAll(IntSet c)` Modifies this set to only remove all ints that are not present in the provided IntSet
`void`	`set(int i)` Add an integer to the set without boxing the parameter or checking if the integer was already present in the set.
`void`	`set(int i, boolean value)` If `value` is `true`, add the integer to the set, otherwise remove the integer from the set.
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`String`	`toString()`
`static void`	`writeTo(ObjectOutput output, SmallIntSet set)`

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

Methods inherited from interface java.util.Set
spliterator

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - SmallIntSet
```
public SmallIntSet()
```
  - SmallIntSet
```
public SmallIntSet(int initialRange)
```
    Create a new IntSet and pre-allocate space for elements 0..initialRange-1.
  - SmallIntSet
```
public SmallIntSet(SmallIntSet other)
```
  - SmallIntSet
```
public SmallIntSet(Set<Integer> set)
```
  - SmallIntSet
```
public SmallIntSet(IntSet set)
```
- Method Detail
  - of
```
public static SmallIntSet of(int i1)
```
  - of
```
public static SmallIntSet of(int i1,
                             int i2)
```
  - of
```
public static SmallIntSet of(int i1,
                             int i2,
                             int i3)
```
  - of
```
public static SmallIntSet of(int... elements)
```
  - of
```
public static SmallIntSet of(PrimitiveIterator.OfInt iterator)
```
  - from
```
public static SmallIntSet from(Set<Integer> set)
```
    Either converts the given set to an IntSet if it is one or creates a new IntSet and copies the contents
    
    Parameters:
    
    set -
    
    Returns:
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Integer>
    
    Specified by:
    
    size in interface Set<Integer>
  - capacity
```
public int capacity()
```
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Integer>
    
    Specified by:
    
    isEmpty in interface Set<Integer>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<Integer>
    
    Specified by:
    
    contains in interface Set<Integer>
  - contains
```
public boolean contains(Integer o)
```
  - contains
```
public boolean contains(int i)
```
    Check if the set contains an integer without boxing the parameter.
    
    Specified by:
    
    contains in interface IntSet
    
    Parameters:
    
    i - the int to check
    
    Returns:
    
    if the set contains the int
  - iterator
```
public PrimitiveIterator.OfInt iterator()
```
    Description copied from interface: IntSet
    
    A primtive iterator that allows iteration over the int values. This iterator supports removal if the set is modifiable.
    
    Specified by:
    
    iterator in interface Iterable<Integer>
    
    Specified by:
    
    iterator in interface Collection<Integer>
    
    Specified by:
    
    iterator in interface Set<Integer>
    
    Specified by:
    
    iterator in interface IntSet
    
    Returns:
    
    the iterator
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Integer>
    
    Specified by:
    
    toArray in interface Set<Integer>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<Integer>
    
    Specified by:
    
    toArray in interface Set<Integer>
  - add
```
public boolean add(Integer i)
```
    Specified by:
    
    add in interface Collection<Integer>
    
    Specified by:
    
    add in interface Set<Integer>
  - add
```
public boolean add(int i)
```
    Add an integer to the set without boxing the parameter.
    
    Specified by:
    
    add in interface IntSet
    
    Parameters:
    
    i - the int value to add
    
    Returns:
    
    whether this int was already present
  - set
```
public void set(int i)
```
    Add an integer to the set without boxing the parameter or checking if the integer was already present in the set.
    
    Specified by:
    
    set in interface IntSet
    
    Parameters:
    
    i - the value to make sure is in the set
  - set
```
public void set(int i,
                boolean value)
```
    If value is true, add the integer to the set, otherwise remove the integer from the set.
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<Integer>
    
    Specified by:
    
    remove in interface Set<Integer>
  - remove
```
public boolean remove(int i)
```
    Remove an integer from the set without boxing.
    
    Specified by:
    
    remove in interface IntSet
    
    Parameters:
    
    i - the int to remove
    
    Returns:
    
    whether the int was present in the set before it was removed
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<Integer>
    
    Specified by:
    
    containsAll in interface Set<Integer>
  - containsAll
```
public boolean containsAll(IntSet set)
```
    Description copied from interface: IntSet
    
    Whether this set contains all ints in the given IntSet
    
    Specified by:
    
    containsAll in interface IntSet
    
    Parameters:
    
    set - the set to check if all are present
    
    Returns:
    
    if the set contains all the ints
  - addAll
```
public boolean addAll(IntSet set)
```
    Description copied from interface: IntSet
    
    Adds all ints from the provided set into this one
    
    Specified by:
    
    addAll in interface IntSet
    
    Parameters:
    
    set - the set of ints to add
    
    Returns:
    
    if this set has a new int in it
  - addAll
```
public boolean addAll(Collection<? extends Integer> c)
```
    Specified by:
    
    addAll in interface Collection<Integer>
    
    Specified by:
    
    addAll in interface Set<Integer>
  - removeAll
```
public boolean removeAll(IntSet set)
```
    Description copied from interface: IntSet
    
    Removes all ints from this IntSet that are in the provided IntSet
    
    Specified by:
    
    removeAll in interface IntSet
    
    Parameters:
    
    set - the ints to remove from this IntSet
    
    Returns:
    
    if this set removed any ints
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<Integer>
    
    Specified by:
    
    removeAll in interface Set<Integer>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<Integer>
    
    Specified by:
    
    retainAll in interface Set<Integer>
  - retainAll
```
public boolean retainAll(IntSet c)
```
    Description copied from interface: IntSet
    
    Modifies this set to only remove all ints that are not present in the provided IntSet
    
    Specified by:
    
    retainAll in interface IntSet
    
    Parameters:
    
    c - the ints this set should kep
    
    Returns:
    
    if this set removed any ints
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Integer>
    
    Specified by:
    
    clear in interface Set<Integer>
  - intStream
```
public IntStream intStream()
```
    Description copied from interface: IntSet
    
    A stream of ints representing the data in this set
    
    Specified by:
    
    intStream in interface IntSet
    
    Returns:
    
    the stream
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<Integer>
    
    Specified by:
    
    equals in interface Set<Integer>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<Integer>
    
    Specified by:
    
    hashCode in interface Set<Integer>
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - writeTo
```
public static void writeTo(ObjectOutput output,
                           SmallIntSet set)
                    throws IOException
```
    Throws:
    
    IOException
  - readFrom
```
public static SmallIntSet readFrom(ObjectInput input)
                            throws IOException
```
    Throws:
    
    IOException

Class SmallIntSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

SmallIntSet

SmallIntSet

SmallIntSet

SmallIntSet

SmallIntSet

Method Detail

of

of

of

of

of

from

size

capacity

isEmpty

contains

contains

contains

iterator

toArray

toArray

add

add

set

set

remove

remove

containsAll

containsAll

addAll

addAll

removeAll

removeAll

retainAll

retainAll

clear

intStream

equals

hashCode

toString

writeTo

readFrom