Top Description Inners Fields Constructors Methods
org.glassfish.grizzly.utils

public Class ArraySet<T>

extends Object
implements Set<T>
Class Inheritance
All Implemented Interfaces
java.util.Set, java.util.Collection, java.lang.Iterable
Imports
java.lang.reflect.Array, java.util.Arrays, .Collection, .Iterator, .NoSuchElementException, .Set

The thread safe set implementation, which uses array to hold its elements. This set could be used, for cases, which require minimum set modifications.
Author
Alexey Stashok

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
ArraySet.Itr

Iterator

Field Summary

Modifier and TypeField and Description
private volatile T[]
private final Class<T>
private final boolean
private final Object

Constructor Summary

AccessConstructor and Description
public
ArraySet(final Class<T> clazz)

public
ArraySet(final Class<T> clazz, final boolean replaceElementIfEquals)

Method Summary

Modifier and TypeMethod and Description
public final boolean

Returns:

true, if at least one element was added to the set and, as result, the size of the set was increased, or false, all element(s) was/were present in the set and, as the result, the set values were just reset.
add
(ArraySet<T>
the elements to add.
source
)

Implements java.util.Set.add.

Add all the elements from the source ArraySet.

public boolean
add(final T element)

Implements java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation).

public final boolean

Returns:

true, if at least one element was added to the set and, as result, the size of the set was increased, or false, all element(s) was/were present in the set and, as the result, the set values were just reset.
addAll
(final T...
the elements to add.
elements
)

Add the element(s) to the set.

public boolean
addAll(Collection<? extends T> collection)

Implements java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation).

public void
clear()

Implements java.util.Set.clear.

Remove all the set elements.

public boolean
contains(Object o)

Implements java.util.Set.contains.

Returns true if this set contains the specified element.

public boolean
containsAll(Collection<?> collection)

Implements java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection.

public final T[]

Returns:

the array.
getArray
()

Get the underlying array.

public final T[]

Returns:

the copy of the underlying array. If the underlying array is null - then null will be returned.
getArrayCopy
()

Get the copy of the underlying array.

public boolean
isEmpty()

Implements java.util.Set.isEmpty.

Returns true if this set contains no elements.

public Iterator<T>
iterator()

Implements java.util.Set.iterator.

Returns an iterator over the elements in this set.

public final T[]

Returns:

the copy of the underlying array. If the underlying array is null - then empty array will be returned.
obtainArrayCopy
()

Get the copy of the underlying array.

public boolean
remove(Object o)

Implements java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation).

public final boolean

Returns:

true, if at least one element was found and removed, or false otherwise.
removeAll
(Object...
the element(s) to remove.
elements
)

Remove element(s) from the set.

public boolean
removeAll(Collection<?> collection)

Implements java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation).

public boolean
retainAll(final Collection<?> collection)

Implements java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation).

public int
size()

Implements java.util.Set.size.

Returns the number of elements in this set (its cardinality).

public Object[]
toArray()

Implements java.util.Set.toArray.

Returns an array containing all of the elements in this set.

public <K> K[]
toArray(K[] a)

Implements java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

arrayback to summary
private volatile T[] array
clazzback to summary
private final Class<T> clazz
replaceElementIfEqualsback to summary
private final boolean replaceElementIfEquals
syncback to summary
private final Object sync

Constructor Detail

ArraySetback to summary
public ArraySet(final Class<T> clazz)
Annotations
@SuppressWarnings:unchecked
ArraySetback to summary
public ArraySet(final Class<T> clazz, final boolean replaceElementIfEquals)
Annotations
@SuppressWarnings:unchecked

Method Detail

addback to summary
public final boolean add(ArraySet<T> source)

Implements java.util.Set.add.

Add all the elements from the source ArraySet.

Parameters
source:ArraySet<T>

the elements to add.

Returns:boolean

true, if at least one element was added to the set and, as result, the size of the set was increased, or false, all element(s) was/were present in the set and, as the result, the set values were just reset.

addback to summary
public boolean add(final T element)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Annotations
@Override
@SuppressWarnings:unchecked
addAllback to summary
public final boolean addAll(final T... elements)

Add the element(s) to the set.

Parameters
elements:T[]

the elements to add.

Returns:boolean

true, if at least one element was added to the set and, as result, the size of the set was increased, or false, all element(s) was/were present in the set and, as the result, the set values were just reset.

Annotations
@SuppressWarnings:unchecked
addAllback to summary
public boolean addAll(Collection<? extends T> collection)

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the addAll operation effectively modifies this set so that its value is the union of the two sets. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

Annotations
@Override
@SuppressWarnings:unchecked
clearback to summary
public void clear()

Implements java.util.Set.clear.

Remove all the set elements.

Annotations
@Override
containsback to summary
public boolean contains(Object o)

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Annotations
@Override
containsAllback to summary
public boolean containsAll(Collection<?> collection)

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Annotations
@Override
getArrayback to summary
public final T[] getArray()

Get the underlying array. Please note, it's not appropriate to modify the returned array's content. Please use add(Object) and remove(Object) instead.

Returns:T[]

the array.

getArrayCopyback to summary
public final T[] getArrayCopy()

Get the copy of the underlying array. If the underlying array is null - then null will be returned.

Returns:T[]

the copy of the underlying array. If the underlying array is null - then null will be returned.

isEmptyback to summary
public boolean isEmpty()

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Annotations
@Override
iteratorback to summary
public Iterator<T> iterator()

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Annotations
@Override
obtainArrayCopyback to summary
public final T[] obtainArrayCopy()

Get the copy of the underlying array. If the underlying array is null - then empty array will be returned.

Returns:T[]

the copy of the underlying array. If the underlying array is null - then empty array will be returned.

Annotations
@SuppressWarnings:unchecked
removeback to summary
public boolean remove(Object o)

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Annotations
@Override
removeAllback to summary
public final boolean removeAll(Object... elements)

Remove element(s) from the set.

Parameters
elements:Object[]

the element(s) to remove.

Returns:boolean

true, if at least one element was found and removed, or false otherwise.

removeAllback to summary
public boolean removeAll(Collection<?> collection)

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). If the specified collection is also a set, this operation effectively modifies this set so that its value is the asymmetric set difference of the two sets.

Annotations
@Override
@SuppressWarnings:unchecked
retainAllback to summary
public boolean retainAll(final Collection<?> collection)

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements that are not contained in the specified collection. If the specified collection is also a set, this operation effectively modifies this set so that its value is the intersection of the two sets.

Annotations
@Override
@SuppressWarnings:unchecked
sizeback to summary
public int size()

Implements java.util.Set.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Annotations
@Override
toArrayback to summary
public Object[] toArray()

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set 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 set. (In other words, this method must allocate a new array even if this set 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.

Annotations
@Override
toArrayback to summary
public <K> K[] toArray(K[] a)

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set 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 set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set 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 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 set known to contain only strings. The following code can be used to dump the set 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().
Annotations
@Override
@SuppressWarnings:unchecked
org.glassfish.grizzly.utils back to summary

private Class ArraySet.Itr

extends Object
implements Iterator<T>
Class Inheritance
All Implemented Interfaces
java.util.Iterator

Iterator

Field Summary

Modifier and TypeField and Description
pack-priv int
pack-priv T
pack-priv T

Constructor Summary

AccessConstructor and Description
public
Itr()

Method Summary

Modifier and TypeMethod and Description
private void
public boolean
hasNext()

Implements java.util.Iterator.hasNext.

Returns true if the iteration has more elements.

public T
next()

Implements java.util.Iterator.next.

Returns the next element in the iteration.

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cursorback to summary
pack-priv int cursor
lastRetback to summary
pack-priv T lastRet
nextElemback to summary
pack-priv T nextElem

Constructor Detail

Itrback to summary
public Itr()

Method Detail

advanceback to summary
private void advance()
Annotations
@SuppressWarnings:unchecked
hasNextback to summary
public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Annotations
@Override
nextback to summary
public T next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Annotations
@SuppressWarnings:unchecked
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override