net.pwall.util

Class MiniSet<T>

java.lang.Object

net.pwall.util.MiniSet<T>

Type Parameters:

T - the set element type

All Implemented Interfaces:

Iterable<T>, Collection<T>, Set<T>

Direct Known Subclasses:

MiniSet0, MiniSet1, MiniSet2, MiniSet3, MiniSet4, MiniSet5

public abstract class MiniSet<T>
extends Object
implements Set<T>

An implementation of Set to provide a simple "contains" mechanism.

Author:

Peter Wall

Constructor Summary

Constructors

Constructor and Description
MiniSet()

Method Summary

Modifier and Type	Method and Description
boolean	add(T e) Modifying operation - not allowed.
boolean	addAll(Collection<? extends T> c) Modifying operation - not allowed.
void	clear() Modifying operation - not allowed.
boolean	containsAll(Collection<?> c) Test whether the collection contains all of the objects in a supplied Collection.
boolean	equals(Object other) Compares the specified object with this set for equality.
int	hashCode() Returns the hash code value for this set.
static <TT> MiniSet<TT>	of() Get an empty MiniSet.
static <TT> Set<TT>	of(TT... values) Get a MiniSet with a variable number of values.
static <TT> MiniSet<TT>	of(TT value) Get a MiniSet containing a single value.
static <TT> MiniSet<TT>	of(TT value0, TT value1) Get a MiniSet containing two values.
static <TT> MiniSet<TT>	of(TT value0, TT value1, TT value2) Get a MiniSet containing three values.
static <TT> MiniSet<TT>	of(TT value0, TT value1, TT value2, TT value3) Get a MiniSet containing four values.
static <TT> MiniSet<TT>	of(TT value0, TT value1, TT value2, TT value3, TT value4) Get a MiniSet containing five values.
boolean	remove(Object o) Modifying operation - not allowed.
boolean	removeAll(Collection<?> c) Modifying operation - not allowed.
boolean	retainAll(Collection<?> c) Modifying operation - not allowed.
protected String	stringOf(Object obj) Return a string representation of the supplied value, guarding against possible recursion.
String	toString() Returns a string representation of this collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

contains, isEmpty, iterator, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

MiniSet

public MiniSet()

Method Detail

clear

public void clear()

Modifying operation - not allowed.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

add

public boolean add(T e)

Modifying operation - not allowed.

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

addAll

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

Modifying operation - not allowed.

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

remove

public boolean remove(Object o)

Modifying operation - not allowed.

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

containsAll

public boolean containsAll(Collection<?> c)

Test whether the collection contains all of the objects in a supplied Collection.

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

Parameters:

c - the other Collection

Returns:

true if the collection contains all of the objects in the other Collection

removeAll

public boolean removeAll(Collection<?> c)

Modifying operation - not allowed.

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

retainAll

public boolean retainAll(Collection<?> c)

Modifying operation - not allowed.

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

Throws:

UnsupportedOperationException - (in all cases)

equals

public boolean equals(Object other)

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

Parameters:

other - object to be compared for equality with this set

Returns:

true if the specified object is equal to this set

hashCode

public int hashCode()

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode() == s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object.hashCode().

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

Returns:

the hash code value for this set

toString

public String toString()

Returns a string representation of this collection. The string representation consists of the string representations of each of the elements, enclosed in square brackets and separated by a comma and a space. Elements are converted to strings by String.valueOf(Object).

Overrides:

toString in class Object

Returns:

a string representation of this collection

stringOf

protected String stringOf(Object obj)

Return a string representation of the supplied value, guarding against possible recursion.

Parameters:

obj - the object

Returns:

the string representation

of

public static <TT> MiniSet<TT> of()

Get an empty MiniSet.

Type Parameters:

TT - the element type

Returns:

an empty MiniSet

of

public static <TT> MiniSet<TT> of(TT value)

Get a MiniSet containing a single value.

Type Parameters:

TT - the element type

Parameters:

value - the value

Returns:

the MiniSet

of

public static <TT> MiniSet<TT> of(TT value0,
                                  TT value1)

Get a MiniSet containing two values.

Type Parameters:

TT - the element type

Parameters:

value0 - the first value

value1 - the second value

Returns:

the MiniSet

of

public static <TT> MiniSet<TT> of(TT value0,
                                  TT value1,
                                  TT value2)

Get a MiniSet containing three values.

Type Parameters:

TT - the element type

Parameters:

value0 - the first value

value1 - the second value

value2 - the third value

Returns:

the MiniSet

of

public static <TT> MiniSet<TT> of(TT value0,
                                  TT value1,
                                  TT value2,
                                  TT value3)

Get a MiniSet containing four values.

Type Parameters:

TT - the element type

Parameters:

value0 - the first value

value1 - the second value

value2 - the third value

value3 - the fourth value

Returns:

the MiniSet

of

public static <TT> MiniSet<TT> of(TT value0,
                                  TT value1,
                                  TT value2,
                                  TT value3,
                                  TT value4)

Get a MiniSet containing five values.

Type Parameters:

TT - the element type

Parameters:

value0 - the first value

value1 - the second value

value2 - the third value

value3 - the fourth value

value4 - the fifth value

Returns:

the MiniSet

of

@SafeVarargs
public static <TT> Set<TT> of(TT... values)

Get a MiniSet with a variable number of values.

Type Parameters:

TT - the element type

Parameters:

values - the values

Returns:

the MiniSet