uk.co.strangeskies.collection

Class ScopedSet<S extends ScopedSet<S,T>,T>

java.lang.Object

uk.co.strangeskies.collection.ScopedSet<S,T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, CollectionDecorator<java.util.Set<T>,T>, SetDecorator<T>, Copyable<S>, Scoped<S>, Self<S>

public abstract class ScopedSet<S extends ScopedSet<S,T>,T>
extends java.lang.Object
implements SetDecorator<T>, Scoped<S>, Copyable<S>

Constructor Summary

Constructors

Modifier	Constructor and Description
	ScopedSet(java.util.Set<T> component)
protected	ScopedSet(S parent, java.util.Set<T> component)

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(java.util.Collection<? extends T> c)
void	collapseIntoParentScope() Collapse this scope into its parent.
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
boolean	equals(java.lang.Object obj)
java.util.Set<T>	getComponent()
java.util.Optional<S>	getParentScope()
int	hashCode()
boolean	isEmpty()
java.util.Iterator<T>	iterator()
static <T> ScopedSet<?,T>	over(java.util.function.Supplier<? extends java.util.Set<T>> componentFactory)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.co.strangeskies.collection.SetDecorator

accumulatingSet, clear, over, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface uk.co.strangeskies.utility.Scoped

nestChildScope

Methods inherited from interface uk.co.strangeskies.utility.Copyable

copy, deepCopy

Methods inherited from interface uk.co.strangeskies.utility.Self

getThis

Constructor Detail

ScopedSet

public ScopedSet(java.util.Set<T> component)

ScopedSet

protected ScopedSet(S parent,
                    java.util.Set<T> component)

Method Detail

getComponent

public java.util.Set<T> getComponent()

Specified by:

getComponent in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

getComponent in interface SetDecorator<T>

over

public static <T> ScopedSet<?,T> over(java.util.function.Supplier<? extends java.util.Set<T>> componentFactory)

add

public boolean add(T e)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.Set<T>

Specified by:

add in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

add in interface SetDecorator<T>

addAll

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

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.Set<T>

Specified by:

addAll in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

addAll in interface SetDecorator<T>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.Set<T>

Specified by:

contains in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

contains in interface SetDecorator<T>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.Set<T>

Specified by:

containsAll in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

containsAll in interface SetDecorator<T>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.Set<T>

Specified by:

iterator in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

iterator in interface SetDecorator<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.Set<T>

Specified by:

isEmpty in interface CollectionDecorator<java.util.Set<T>,T>

Specified by:

isEmpty in interface SetDecorator<T>

getParentScope

public java.util.Optional<S> getParentScope()

Specified by:

getParentScope in interface Scoped<S extends ScopedSet<S,T>>

Returns:

the parent scope if one exists, otherwise null

collapseIntoParentScope

public void collapseIntoParentScope()

Description copied from interface: Scoped

Collapse this scope into its parent. This will result in the contents of this scope becoming visible to the parent scope, and all the rest of that scope's children.

Specified by:

collapseIntoParentScope in interface Scoped<S extends ScopedSet<S,T>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<T>

Specified by:

hashCode in interface java.util.Set<T>

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<T>

Specified by:

equals in interface java.util.Set<T>

Overrides:

equals in class java.lang.Object