1 package org.djutils.immutablecollections;
2
3 import java.util.ArrayList;
4 import java.util.Collection;
5 import java.util.List;
6
7 /**
8 * An immutable wrapper for an ArrayList.
9 * <p>
10 * Copyright (c) 2016-2024 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 * @param <E> the type of content of this List
19 */
20 public class ImmutableArrayList<E> extends ImmutableAbstractList<E>
21 {
22 /** */
23 private static final long serialVersionUID = 20160507L;
24
25 /**
26 * @param collection Collection<? extends E>; the collection to use for the immutable list.
27 */
28 public ImmutableArrayList(final Collection<? extends E> collection)
29 {
30 super(new ArrayList<E>(collection), Immutable.COPY);
31 }
32
33 /**
34 * @param list List<E>; the list to use for the immutable list.
35 * @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
36 */
37 public ImmutableArrayList(final List<E> list, final Immutable copyOrWrap)
38 {
39 super(copyOrWrap == Immutable.COPY ? new ArrayList<E>(list) : list, copyOrWrap);
40 }
41
42 /**
43 * @param collection ImmutableAbstractCollection<? extends E>; the collection to use for the immutable list.
44 */
45 public ImmutableArrayList(final ImmutableAbstractCollection<? extends E> collection)
46 {
47 super(new ArrayList<E>(collection.getUnderlyingCollection()), Immutable.COPY);
48 }
49
50 /**
51 * @param list ImmutableAbstractList<E>; the list to use for the immutable list.
52 * @param copyOrWrap COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection
53 */
54 public ImmutableArrayList(final ImmutableAbstractList<E> list, final Immutable copyOrWrap)
55 {
56 super(copyOrWrap == Immutable.COPY ? new ArrayList<E>(list.getUnderlyingCollection()) : list.getUnderlyingCollection(),
57 copyOrWrap);
58 }
59
60 @Override
61 public final ArrayList<E> toList()
62 {
63 return new ArrayList<E>(getUnderlyingCollection());
64 }
65
66 @Override
67 protected List<E> getUnderlyingCollection()
68 {
69 return super.getUnderlyingCollection();
70 }
71
72 @Override
73 public final ImmutableList<E> subList(final int fromIndex, final int toIndex)
74 {
75 return new ImmutableArrayList<>(getUnderlyingCollection().subList(fromIndex, toIndex));
76 }
77
78 @Override
79 public final String toString()
80 {
81 List<E> list = getUnderlyingCollection();
82 if (null == list)
83 {
84 return "ImmutableArrayList []";
85 }
86 return "ImmutableArrayList [" + list.toString() + "]";
87 }
88
89 }