speiger.src.collections.objects.utils

Class ObjectSets

java.lang.Object

speiger.src.collections.objects.utils.ObjectSets

public class ObjectSets
extends java.lang.Object

A Helper class for sets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectSets.UnmodifiableSet<T> Unmodifyable Set wrapper that helps is used with unmodifyableSet function

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectSet<?>	EMPTY Empty Set Variable

Constructor Summary

Constructors

Constructor and Description
ObjectSets()

Method Summary

Modifier and Type	Method and Description
static <T> ObjectSet<T>	empty() EmptySet getter
static <T> ObjectSet<T>	singletonSet(T element) Creates a Singleton set of a given element
static <T> ObjectNavigableSet<T>	synchronizedSet(ObjectNavigableSet<T> s) Creates a Synchronized NavigableSet while preserving the ITrimmable interface
static <T> ObjectNavigableSet<T>	synchronizedSet(ObjectNavigableSet<T> s, java.lang.Object mutex) Creates a Synchronized NavigableSet while preserving the ITrimmable interface
static <T> ObjectSet<T>	synchronizedSet(ObjectSet<T> s) Creates a Synchronized set while preserving the ITrimmable interface
static <T> ObjectSet<T>	synchronizedSet(ObjectSet<T> s, java.lang.Object mutex) Creates a Synchronized set while preserving the ITrimmable interface
static <T> ObjectSortedSet<T>	synchronizedSet(ObjectSortedSet<T> s) Creates a Synchronized SortedSet while preserving the ITrimmable interface
static <T> ObjectSortedSet<T>	synchronizedSet(ObjectSortedSet<T> s, java.lang.Object mutex) Creates a Synchronized SortedSet while preserving the ITrimmable interface
static <T> ObjectNavigableSet<T>	unmodifiable(ObjectNavigableSet<T> s) Creates Unmodifyable NavigableSet wrapper
static <T> ObjectSet<T>	unmodifiable(ObjectSet<T> s) Creates Unmodifyable Set wrapper
static <T> ObjectSortedSet<T>	unmodifiable(ObjectSortedSet<T> s) Creates Unmodifyable SortedSet wrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY

public static final ObjectSet<?> EMPTY

Empty Set Variable

Constructor Detail

ObjectSets

public ObjectSets()

Method Detail

empty

public static <T> ObjectSet<T> empty()

EmptySet getter

Type Parameters:

T - the type of elements maintained by this Collection

Returns:

a EmptySet

synchronizedSet

public static <T> ObjectSet<T> synchronizedSet(ObjectSet<T> s)

Creates a Synchronized set while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

Returns:

a set that is synchronized

Note:

if the set is already synchronized then it will just self return it

synchronizedSet

public static <T> ObjectSet<T> synchronizedSet(ObjectSet<T> s,
                                               java.lang.Object mutex)

Creates a Synchronized set while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

mutex - controller for access

Returns:

a set that is synchronized

Note:

if the set is already synchronized then it will just self return it

synchronizedSet

public static <T> ObjectSortedSet<T> synchronizedSet(ObjectSortedSet<T> s)

Creates a Synchronized SortedSet while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

Returns:

a SortedSet that is synchronized

Note:

if the set is already synchronized then it will just self return it

synchronizedSet

public static <T> ObjectSortedSet<T> synchronizedSet(ObjectSortedSet<T> s,
                                                     java.lang.Object mutex)

Creates a Synchronized SortedSet while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

mutex - controller for access

Returns:

a SortedSet that is synchronized

Note:

if the set is already synchronized then it will just self return it

synchronizedSet

public static <T> ObjectNavigableSet<T> synchronizedSet(ObjectNavigableSet<T> s)

Creates a Synchronized NavigableSet while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

Returns:

a NavigableSet that is synchronized

Note:

if the set is already synchronized then it will just self return it

synchronizedSet

public static <T> ObjectNavigableSet<T> synchronizedSet(ObjectNavigableSet<T> s,
                                                        java.lang.Object mutex)

Creates a Synchronized NavigableSet while preserving the ITrimmable interface

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - the set that should be synchronized

mutex - controller for access

Returns:

a NavigableSet that is synchronized

Note:

if the set is already synchronized then it will just self return it

unmodifiable

public static <T> ObjectSet<T> unmodifiable(ObjectSet<T> s)

Creates Unmodifyable Set wrapper

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - set that should be made unmodifyable

Returns:

a UnmodifyableSet, if the set is already unmodifyable then it returns itself

unmodifiable

public static <T> ObjectSortedSet<T> unmodifiable(ObjectSortedSet<T> s)

Creates Unmodifyable SortedSet wrapper

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - sortedSet that should be made unmodifyable

Returns:

a UnmodifyableSortedSet, if the set is already unmodifyable then it returns itself

unmodifiable

public static <T> ObjectNavigableSet<T> unmodifiable(ObjectNavigableSet<T> s)

Creates Unmodifyable NavigableSet wrapper

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

s - navigableSet that should be made unmodifyable

Returns:

a UnmodifyableNavigableSet, if the set is already unmodifyable then it returns itself

singletonSet

public static <T> ObjectSet<T> singletonSet(T element)

Creates a Singleton set of a given element

Type Parameters:

T - the type of elements maintained by this Collection

Parameters:

element - the element that should be converted into a singleton set

Returns:

a singletonset of the given element