Package org.optaplanner.core.impl.util

Class FieldBasedScalingSet<E>

java.lang.Object

org.optaplanner.core.impl.util.FieldBasedScalingSet<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, Set<E>

public final class FieldBasedScalingSet<E>
extends Object
implements Set<E>

Uses a given Set as storage unless it is the first and only value, in which case it uses a field. This helps avoid the overhead of creating and accessing the set if we only have 1 value. This implementation is not thread-safe, regardless of the underlying Set. Iteration order of elements is specified by the underlying Set.

Constructor Summary

Constructors

Constructor	Description
FieldBasedScalingSet(Supplier<Set<E>> setSupplier)

Method Summary

Modifier and Type	Method	Description
boolean	add(E value)
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object value)
boolean	containsAll(Collection<?> c)
void	forEach(Consumer<? super E> action)
boolean	isEmpty()
Iterator<E>	iterator()	As defined by Set.iterator().
boolean	remove(Object value)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.Set

equals, hashCode, spliterator

Constructor Detail

FieldBasedScalingSet

public FieldBasedScalingSet(Supplier<Set<E>> setSupplier)

Method Detail

add

public boolean add(E value)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

remove

public boolean remove(Object value)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

addAll

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

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

contains

public boolean contains(Object value)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

iterator

public Iterator<E> iterator()

As defined by Set.iterator(). May throw an exception if the iterator is used to remove an element while the set is based on a field.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Set<E>

Returns:

never null

forEach

public void forEach(Consumer<? super E> action)

Specified by:

forEach in interface Iterable<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toString

public String toString()

Overrides:

toString in class Object