org.opentrafficsim.base.immutablecollections

Interface ImmutableSet<E>

Type Parameters:

E - the type of content of this Set

All Superinterfaces:

ImmutableCollection<E>, Iterable<E>, Serializable

All Known Subinterfaces:

ImmutableNavigableSet<E>, ImmutableSortedSet<E>

All Known Implementing Classes:

ImmutableAbstractSet, ImmutableHashSet, ImmutableLinkedHashSet, ImmutableTreeSet

public interface ImmutableSet<E>
extends ImmutableCollection<E>

A Set interface without the methods that can change it. The constructor of the ImmutableSet needs to be given an initial Set.

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Force to redefine equals for the implementations of immutable collection classes.
int	hashCode() Force to redefine hashCode for the implementations of immutable collection classes.
Set<E>	toSet() Returns a modifiable copy of this immutable set.

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

contains, containsAll, containsAll, isCopy, isEmpty, isWrap, iterator, parallelStream, size, spliterator, stream, toArray, toArray, toCollection

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

toSet

Set<E> toSet()

Returns a modifiable copy of this immutable set.

Returns:

a modifiable copy of this immutable set.

equals

boolean equals(Object obj)

Force to redefine equals for the implementations of immutable collection classes.

Specified by:

equals in interface ImmutableCollection<E>

Overrides:

equals in class Object

Parameters:

obj - the object to compare this collection with

Returns:

whether the objects are equal

hashCode

int hashCode()

Force to redefine hashCode for the implementations of immutable collection classes.

Specified by:

hashCode in interface ImmutableCollection<E>

Overrides:

hashCode in class Object

Returns:

the calculated hashCode