1 package org.djutils.immutablecollections;
2
3 import java.util.Collection;
4 import java.util.LinkedHashSet;
5 import java.util.Set;
6
7 /**
8 * An immutable wrapper for a LinkedHashSet.
9 * <p>
10 * Copyright (c) 2016-2020 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See
11 * for project information <a href="https://djutils.org" target="_blank"> https://djutils.org</a>. The DJUTILS project is
12 * distributed under a three-clause BSD-style license, which can be found at
13 * <a href="https://djutils.org/docs/license.html" target="_blank"> https://djutils.org/docs/license.html</a>.
14 * </p>
15 * $, initial version May 7, 2016 <br>
16 * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
17 * @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
18 * @author <a href="https://www.transport.citg.tudelft.nl">Wouter Schakel</a>
19 * @param <E> the type of content of this Set
20 */
21 public class ImmutableLinkedHashSet<E> extends ImmutableAbstractSet<E>
22 {
23 /** */
24 private static final long serialVersionUID = 20160507L;
25
26 /**
27 * @param collection Collection<? extends E>; the collection to use for the immutable set.
28 */
29 public ImmutableLinkedHashSet(final Collection<? extends E> collection)
30 {
31 super(new LinkedHashSet<E>(collection), Immutable.COPY);
32 }
33
34 /**
35 * @param collection Set<E>; the collection to use for the immutable set.
36 * @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
37 */
38 public ImmutableLinkedHashSet(final Set<E> collection, final Immutable copyOrWrap)
39 {
40 super(copyOrWrap == Immutable.COPY ? new LinkedHashSet<E>(collection) : collection, copyOrWrap);
41 }
42
43 /**
44 * @param collection ImmutableAbstractCollection<? extends E>; the collection to use for the immutable set.
45 */
46 public ImmutableLinkedHashSet(final ImmutableAbstractCollection<? extends E> collection)
47 {
48 super(new LinkedHashSet<E>(collection.getUnderlyingCollection()), Immutable.COPY);
49 }
50
51 /**
52 * @param set ImmutableAbstractSet<E>; the collection to use for the immutable set.
53 * @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
54 */
55 public ImmutableLinkedHashSet(final ImmutableAbstractSet<E> set, final Immutable copyOrWrap)
56 {
57 super(copyOrWrap == Immutable.COPY ? new LinkedHashSet<E>(set.getUnderlyingCollection())
58 : set.getUnderlyingCollection(), copyOrWrap);
59 }
60
61 /** {@inheritDoc} */
62 @Override
63 protected Set<E> getUnderlyingCollection()
64 {
65 return super.getUnderlyingCollection();
66 }
67
68 /** {@inheritDoc} */
69 @Override
70 public final Set<E> toSet()
71 {
72 return new LinkedHashSet<E>(getUnderlyingCollection());
73 }
74
75 /** {@inheritDoc} */
76 @Override
77 public final String toString()
78 {
79 Set<E> set = getUnderlyingCollection();
80 if (null == set)
81 {
82 return "ImmutableLinkedHashSet []";
83 }
84 return "ImmutableLinkedHashSet [" + set.toString() + "]";
85 }
86
87 }