Module com.aoapps.collections

Package com.aoapps.collections

Class UnmodifiableArraySet<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

com.aoapps.collections.UnmodifiableArraySet<E>

All Implemented Interfaces:

Externalizable, Serializable, Iterable<E>, Collection<E>, Set<E>

public class UnmodifiableArraySet<E>
extends AbstractSet<E>
implements Externalizable

An unmodifiable compact Set implementation that stores the elements in hashCode order. The emphasis is to use as little heap space as possible - this is not a general-purpose Set implementation.

This set does not support null values.

This set will generally operate at O(log n) due to binary search. In general, it will not be as fast as the O(1) behavior of HashSet. Here we give up speed to save space.

This set is not thread safe.

Author:

AO Industries, Inc.

See Also:

to properly sort objects before adding to the set, Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableArraySet()
UnmodifiableArraySet(E... elements)	Uses the provided elements, which must already be sorted in hashCode order and unique.
UnmodifiableArraySet(Collection<E> elements)	Uses the provided elements collection, which must already be sorted in hashCode order and unique.

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
boolean	isEmpty()
Iterator<E>	iterator()
void	readExternal(ObjectInput in)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Constructor Detail

UnmodifiableArraySet

@SafeVarargs
public UnmodifiableArraySet(E... elements)

Uses the provided elements, which must already be sorted in hashCode order and unique. The sort order and uniqueness is only checked with assertions enabled.

See Also:

to properly sort objects before adding to the set

UnmodifiableArraySet

public UnmodifiableArraySet(Collection<E> elements)

Uses the provided elements collection, which must already be sorted in hashCode order and unique. A defensive copy is made. The sort order and uniqueness is only checked with assertions enabled.

See Also:

to properly sort objects before adding to the set

UnmodifiableArraySet

public UnmodifiableArraySet()

Method Detail

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

Overrides:

contains in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Specified by:

iterator in class AbstractCollection<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

Overrides:

toArray in class AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

Overrides:

add in class AbstractCollection<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

Overrides:

addAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

Overrides:

retainAll in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

Overrides:

removeAll in class AbstractSet<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

Overrides:

clear in class AbstractCollection<E>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException