org.opentrafficsim.base.immutablecollections

Class ImmutableHashSet<E>

java.lang.Object

org.opentrafficsim.base.immutablecollections.ImmutableAbstractSet<E>

org.opentrafficsim.base.immutablecollections.ImmutableHashSet<E>

Type Parameters:

E - the type of content of this Set

All Implemented Interfaces:

Serializable, Iterable<E>, ImmutableCollection<E>, ImmutableSet<E>

Direct Known Subclasses:

ImmutableLinkedHashSet

public class ImmutableHashSet<E>
extends ImmutableAbstractSet<E>

An immutable wrapper for a HashSet.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version May 7, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImmutableHashSet(Collection<E> collection)
protected	ImmutableHashSet(Collection<E> collection, boolean copy)
	ImmutableHashSet(Collection<E> collection, Immutable copyOrWrap)
	ImmutableHashSet(ImmutableCollection<E> collection)
	ImmutableHashSet(ImmutableCollection<E> collection, Immutable copyOrWrap)

Method Summary

Modifier and Type	Method and Description
protected HashSet<E>	getSet() Prepare the set of the right type for use a subclass.
Set<E>	toSet() Returns a modifiable copy of this immutable set.
String	toString()

Methods inherited from class org.opentrafficsim.base.immutablecollections.ImmutableAbstractSet

contains, containsAll, containsAll, equals, forEach, hashCode, isEmpty, isWrap, iterator, parallelStream, size, spliterator, stream, toArray, toArray, toCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableCollection

isCopy

Constructor Detail

ImmutableHashSet

public ImmutableHashSet(Collection<E> collection)

Parameters:

collection - the collection to use as the immutable set.

ImmutableHashSet

public ImmutableHashSet(Collection<E> collection,
                        Immutable copyOrWrap)

Parameters:

collection - the collection to use as the immutable set.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

ImmutableHashSet

protected ImmutableHashSet(Collection<E> collection,
                           boolean copy)

Parameters:

collection - the collection to use as the immutable set.

copy - boolean; indicates whether the immutable is a copy or a wrap

ImmutableHashSet

public ImmutableHashSet(ImmutableCollection<E> collection)

Parameters:

collection - the collection to use as the immutable set.

ImmutableHashSet

public ImmutableHashSet(ImmutableCollection<E> collection,
                        Immutable copyOrWrap)

Parameters:

collection - the collection to use as the immutable set.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

Method Detail

getSet

protected final HashSet<E> getSet()

Prepare the set of the right type for use a subclass. Implement e.g. as follows:

  @Override
 protected ArraySet<E> getSet()
 {
     return (ArraySet<E>) super.getSet();
 }
 

Overrides:

getSet in class ImmutableAbstractSet<E>

Returns:

the set of the right type for use a subclass

toSet

public final Set<E> toSet()

Returns a modifiable copy of this immutable set.

Returns:

a modifiable copy of this immutable set.

toString

public String toString()

Overrides:

toString in class ImmutableAbstractSet<E>