001/*
002 * Copyright (C) 2008 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.collect;
018
019import static com.google.common.base.Preconditions.checkNotNull;
020
021import com.google.common.annotations.GwtCompatible;
022import com.google.errorprone.annotations.CanIgnoreReturnValue;
023import com.google.errorprone.annotations.DoNotMock;
024import java.io.Serializable;
025import java.util.AbstractCollection;
026import java.util.Collection;
027import java.util.Collections;
028import java.util.HashSet;
029import java.util.Iterator;
030import java.util.List;
031import java.util.Spliterator;
032import java.util.Spliterators;
033import java.util.function.Predicate;
034import org.checkerframework.checker.nullness.qual.Nullable;
035
036/**
037 * A {@link Collection} whose contents will never change, and which offers a few additional
038 * guarantees detailed below.
039 *
040 * <p><b>Warning:</b> avoid <i>direct</i> usage of {@link ImmutableCollection} as a type (just as
041 * with {@link Collection} itself). Prefer subtypes such as {@link ImmutableSet} or {@link
042 * ImmutableList}, which have well-defined {@link #equals} semantics, thus avoiding a common source
043 * of bugs and confusion.
044 *
045 * <h3>About <i>all</i> {@code Immutable-} collections</h3>
046 *
047 * <p>The remainder of this documentation applies to every public {@code Immutable-} type in this
048 * package, whether it is a subtype of {@code ImmutableCollection} or not.
049 *
050 * <h4>Guarantees</h4>
051 *
052 * <p>Each makes the following guarantees:
053 *
054 * <ul>
055 *   <li><b>Shallow immutability.</b> Elements can never be added, removed or replaced in this
056 *       collection. This is a stronger guarantee than that of {@link
057 *       Collections#unmodifiableCollection}, whose contents change whenever the wrapped collection
058 *       is modified.
059 *   <li><b>Null-hostility.</b> This collection will never contain a null element.
060 *   <li><b>Deterministic iteration.</b> The iteration order is always well-defined, depending on
061 *       how the collection was created. Typically this is insertion order unless an explicit
062 *       ordering is otherwise specified (e.g. {@link ImmutableSortedSet#naturalOrder}). See the
063 *       appropriate factory method for details. View collections such as {@link
064 *       ImmutableMultiset#elementSet} iterate in the same order as the parent, except as noted.
065 *   <li><b>Thread safety.</b> It is safe to access this collection concurrently from multiple
066 *       threads.
067 *   <li><b>Integrity.</b> This type cannot be subclassed outside this package (which would allow
068 *       these guarantees to be violated).
069 * </ul>
070 *
071 * <h4>"Interfaces", not implementations</h4>
072 *
073 * <p>These are classes instead of interfaces to prevent external subtyping, but should be thought
074 * of as interfaces in every important sense. Each public class such as {@link ImmutableSet} is a
075 * <i>type</i> offering meaningful behavioral guarantees. This is substantially different from the
076 * case of (say) {@link HashSet}, which is an <i>implementation</i>, with semantics that were
077 * largely defined by its supertype.
078 *
079 * <p>For field types and method return types, you should generally use the immutable type (such as
080 * {@link ImmutableList}) instead of the general collection interface type (such as {@link List}).
081 * This communicates to your callers all of the semantic guarantees listed above, which is almost
082 * always very useful information.
083 *
084 * <p>On the other hand, a <i>parameter</i> type of {@link ImmutableList} is generally a nuisance to
085 * callers. Instead, accept {@link Iterable} and have your method or constructor body pass it to the
086 * appropriate {@code copyOf} method itself.
087 *
088 * <p>Expressing the immutability guarantee directly in the type that user code references is a
089 * powerful advantage. Although Java offers certain immutable collection factory methods, such as
090 * {@link Collections#singleton(Object)} and <a
091 * href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html#immutable">{@code Set.of}</a>,
092 * we recommend using <i>these</i> classes instead for this reason (as well as for consistency).
093 *
094 * <h4>Creation</h4>
095 *
096 * <p>Except for logically "abstract" types like {@code ImmutableCollection} itself, each {@code
097 * Immutable} type provides the static operations you need to obtain instances of that type. These
098 * usually include:
099 *
100 * <ul>
101 *   <li>Static methods named {@code of}, accepting an explicit list of elements or entries.
102 *   <li>Static methods named {@code copyOf} (or {@code copyOfSorted}), accepting an existing
103 *       collection whose contents should be copied.
104 *   <li>A static nested {@code Builder} class which can be used to populate a new immutable
105 *       instance.
106 * </ul>
107 *
108 * <h4>Warnings</h4>
109 *
110 * <ul>
111 *   <li><b>Warning:</b> as with any collection, it is almost always a bad idea to modify an element
112 *       (in a way that affects its {@link Object#equals} behavior) while it is contained in a
113 *       collection. Undefined behavior and bugs will result. It's generally best to avoid using
114 *       mutable objects as elements at all, as many users may expect your "immutable" object to be
115 *       <i>deeply</i> immutable.
116 * </ul>
117 *
118 * <h4>Performance notes</h4>
119 *
120 * <ul>
121 *   <li>Implementations can be generally assumed to prioritize memory efficiency, then speed of
122 *       access, and lastly speed of creation.
123 *   <li>The {@code copyOf} methods will sometimes recognize that the actual copy operation is
124 *       unnecessary; for example, {@code copyOf(copyOf(anArrayList))} should copy the data only
125 *       once. This reduces the expense of habitually making defensive copies at API boundaries.
126 *       However, the precise conditions for skipping the copy operation are undefined.
127 *   <li><b>Warning:</b> a view collection such as {@link ImmutableMap#keySet} or {@link
128 *       ImmutableList#subList} may retain a reference to the entire data set, preventing it from
129 *       being garbage collected. If some of the data is no longer reachable through other means,
130 *       this constitutes a memory leak. Pass the view collection to the appropriate {@code copyOf}
131 *       method to obtain a correctly-sized copy.
132 *   <li>The performance of using the associated {@code Builder} class can be assumed to be no
133 *       worse, and possibly better, than creating a mutable collection and copying it.
134 *   <li>Implementations generally do not cache hash codes. If your element or key type has a slow
135 *       {@code hashCode} implementation, it should cache it itself.
136 * </ul>
137 *
138 * <h4>Example usage</h4>
139 *
140 * <pre>{@code
141 * class Foo {
142 *   private static final ImmutableSet<String> RESERVED_CODES =
143 *       ImmutableSet.of("AZ", "CQ", "ZX");
144 *
145 *   private final ImmutableSet<String> codes;
146 *
147 *   public Foo(Iterable<String> codes) {
148 *     this.codes = ImmutableSet.copyOf(codes);
149 *     checkArgument(Collections.disjoint(this.codes, RESERVED_CODES));
150 *   }
151 * }
152 * }</pre>
153 *
154 * <h3>See also</h3>
155 *
156 * <p>See the Guava User Guide article on <a href=
157 * "https://github.com/google/guava/wiki/ImmutableCollectionsExplained"> immutable collections</a>.
158 *
159 * @since 2.0
160 */
161@DoNotMock("Use ImmutableList.of or another implementation")
162@GwtCompatible(emulated = true)
163@SuppressWarnings("serial") // we're overriding default serialization
164// TODO(kevinb): I think we should push everything down to "BaseImmutableCollection" or something,
165// just to do everything we can to emphasize the "practically an interface" nature of this class.
166public abstract class ImmutableCollection<E> extends AbstractCollection<E> implements Serializable {
167  /*
168   * We expect SIZED (and SUBSIZED, if applicable) to be added by the spliterator factory methods.
169   * These are properties of the collection as a whole; SIZED and SUBSIZED are more properties of
170   * the spliterator implementation.
171   */
172  static final int SPLITERATOR_CHARACTERISTICS =
173      Spliterator.IMMUTABLE | Spliterator.NONNULL | Spliterator.ORDERED;
174
175  ImmutableCollection() {}
176
177  /** Returns an unmodifiable iterator across the elements in this collection. */
178  @Override
179  public abstract UnmodifiableIterator<E> iterator();
180
181  @Override
182  public Spliterator<E> spliterator() {
183    return Spliterators.spliterator(this, SPLITERATOR_CHARACTERISTICS);
184  }
185
186  private static final Object[] EMPTY_ARRAY = {};
187
188  @Override
189  public final Object[] toArray() {
190    return toArray(EMPTY_ARRAY);
191  }
192
193  @CanIgnoreReturnValue
194  @Override
195  public final <T> T[] toArray(T[] other) {
196    checkNotNull(other);
197    int size = size();
198
199    if (other.length < size) {
200      Object[] internal = internalArray();
201      if (internal != null) {
202        return Platform.copy(internal, internalArrayStart(), internalArrayEnd(), other);
203      }
204      other = ObjectArrays.newArray(other, size);
205    } else if (other.length > size) {
206      other[size] = null;
207    }
208    copyIntoArray(other, 0);
209    return other;
210  }
211
212  /** If this collection is backed by an array of its elements in insertion order, returns it. */
213  @Nullable
214  Object[] internalArray() {
215    return null;
216  }
217
218  /**
219   * If this collection is backed by an array of its elements in insertion order, returns the offset
220   * where this collection's elements start.
221   */
222  int internalArrayStart() {
223    throw new UnsupportedOperationException();
224  }
225
226  /**
227   * If this collection is backed by an array of its elements in insertion order, returns the offset
228   * where this collection's elements end.
229   */
230  int internalArrayEnd() {
231    throw new UnsupportedOperationException();
232  }
233
234  @Override
235  public abstract boolean contains(@Nullable Object object);
236
237  /**
238   * Guaranteed to throw an exception and leave the collection unmodified.
239   *
240   * @throws UnsupportedOperationException always
241   * @deprecated Unsupported operation.
242   */
243  @CanIgnoreReturnValue
244  @Deprecated
245  @Override
246  public final boolean add(E e) {
247    throw new UnsupportedOperationException();
248  }
249
250  /**
251   * Guaranteed to throw an exception and leave the collection unmodified.
252   *
253   * @throws UnsupportedOperationException always
254   * @deprecated Unsupported operation.
255   */
256  @CanIgnoreReturnValue
257  @Deprecated
258  @Override
259  public final boolean remove(Object object) {
260    throw new UnsupportedOperationException();
261  }
262
263  /**
264   * Guaranteed to throw an exception and leave the collection unmodified.
265   *
266   * @throws UnsupportedOperationException always
267   * @deprecated Unsupported operation.
268   */
269  @CanIgnoreReturnValue
270  @Deprecated
271  @Override
272  public final boolean addAll(Collection<? extends E> newElements) {
273    throw new UnsupportedOperationException();
274  }
275
276  /**
277   * Guaranteed to throw an exception and leave the collection unmodified.
278   *
279   * @throws UnsupportedOperationException always
280   * @deprecated Unsupported operation.
281   */
282  @CanIgnoreReturnValue
283  @Deprecated
284  @Override
285  public final boolean removeAll(Collection<?> oldElements) {
286    throw new UnsupportedOperationException();
287  }
288
289  /**
290   * Guaranteed to throw an exception and leave the collection unmodified.
291   *
292   * @throws UnsupportedOperationException always
293   * @deprecated Unsupported operation.
294   */
295  @CanIgnoreReturnValue
296  @Deprecated
297  @Override
298  public final boolean removeIf(Predicate<? super E> filter) {
299    throw new UnsupportedOperationException();
300  }
301
302  /**
303   * Guaranteed to throw an exception and leave the collection unmodified.
304   *
305   * @throws UnsupportedOperationException always
306   * @deprecated Unsupported operation.
307   */
308  @Deprecated
309  @Override
310  public final boolean retainAll(Collection<?> elementsToKeep) {
311    throw new UnsupportedOperationException();
312  }
313
314  /**
315   * Guaranteed to throw an exception and leave the collection unmodified.
316   *
317   * @throws UnsupportedOperationException always
318   * @deprecated Unsupported operation.
319   */
320  @Deprecated
321  @Override
322  public final void clear() {
323    throw new UnsupportedOperationException();
324  }
325
326  /**
327   * Returns an {@code ImmutableList} containing the same elements, in the same order, as this
328   * collection.
329   *
330   * <p><b>Performance note:</b> in most cases this method can return quickly without actually
331   * copying anything. The exact circumstances under which the copy is performed are undefined and
332   * subject to change.
333   *
334   * @since 2.0
335   */
336  public ImmutableList<E> asList() {
337    switch (size()) {
338      case 0:
339        return ImmutableList.of();
340      case 1:
341        return ImmutableList.of(iterator().next());
342      default:
343        return new RegularImmutableAsList<E>(this, toArray());
344    }
345  }
346
347  /**
348   * Returns {@code true} if this immutable collection's implementation contains references to
349   * user-created objects that aren't accessible via this collection's methods. This is generally
350   * used to determine whether {@code copyOf} implementations should make an explicit copy to avoid
351   * memory leaks.
352   */
353  abstract boolean isPartialView();
354
355  /**
356   * Copies the contents of this immutable collection into the specified array at the specified
357   * offset. Returns {@code offset + size()}.
358   */
359  @CanIgnoreReturnValue
360  int copyIntoArray(Object[] dst, int offset) {
361    for (E e : this) {
362      dst[offset++] = e;
363    }
364    return offset;
365  }
366
367  Object writeReplace() {
368    // We serialize by default to ImmutableList, the simplest thing that works.
369    return new ImmutableList.SerializedForm(toArray());
370  }
371
372  /**
373   * Abstract base class for builders of {@link ImmutableCollection} types.
374   *
375   * @since 10.0
376   */
377  @DoNotMock
378  public abstract static class Builder<E> {
379    static final int DEFAULT_INITIAL_CAPACITY = 4;
380
381    static int expandedCapacity(int oldCapacity, int minCapacity) {
382      if (minCapacity < 0) {
383        throw new AssertionError("cannot store more than MAX_VALUE elements");
384      }
385      // careful of overflow!
386      int newCapacity = oldCapacity + (oldCapacity >> 1) + 1;
387      if (newCapacity < minCapacity) {
388        newCapacity = Integer.highestOneBit(minCapacity - 1) << 1;
389      }
390      if (newCapacity < 0) {
391        newCapacity = Integer.MAX_VALUE;
392        // guaranteed to be >= newCapacity
393      }
394      return newCapacity;
395    }
396
397    Builder() {}
398
399    /**
400     * Adds {@code element} to the {@code ImmutableCollection} being built.
401     *
402     * <p>Note that each builder class covariantly returns its own type from this method.
403     *
404     * @param element the element to add
405     * @return this {@code Builder} instance
406     * @throws NullPointerException if {@code element} is null
407     */
408    @CanIgnoreReturnValue
409    public abstract Builder<E> add(E element);
410
411    /**
412     * Adds each element of {@code elements} to the {@code ImmutableCollection} being built.
413     *
414     * <p>Note that each builder class overrides this method in order to covariantly return its own
415     * type.
416     *
417     * @param elements the elements to add
418     * @return this {@code Builder} instance
419     * @throws NullPointerException if {@code elements} is null or contains a null element
420     */
421    @CanIgnoreReturnValue
422    public Builder<E> add(E... elements) {
423      for (E element : elements) {
424        add(element);
425      }
426      return this;
427    }
428
429    /**
430     * Adds each element of {@code elements} to the {@code ImmutableCollection} being built.
431     *
432     * <p>Note that each builder class overrides this method in order to covariantly return its own
433     * type.
434     *
435     * @param elements the elements to add
436     * @return this {@code Builder} instance
437     * @throws NullPointerException if {@code elements} is null or contains a null element
438     */
439    @CanIgnoreReturnValue
440    public Builder<E> addAll(Iterable<? extends E> elements) {
441      for (E element : elements) {
442        add(element);
443      }
444      return this;
445    }
446
447    /**
448     * Adds each element of {@code elements} to the {@code ImmutableCollection} being built.
449     *
450     * <p>Note that each builder class overrides this method in order to covariantly return its own
451     * type.
452     *
453     * @param elements the elements to add
454     * @return this {@code Builder} instance
455     * @throws NullPointerException if {@code elements} is null or contains a null element
456     */
457    @CanIgnoreReturnValue
458    public Builder<E> addAll(Iterator<? extends E> elements) {
459      while (elements.hasNext()) {
460        add(elements.next());
461      }
462      return this;
463    }
464
465    /**
466     * Returns a newly-created {@code ImmutableCollection} of the appropriate type, containing the
467     * elements provided to this builder.
468     *
469     * <p>Note that each builder class covariantly returns the appropriate type of {@code
470     * ImmutableCollection} from this method.
471     */
472    public abstract ImmutableCollection<E> build();
473  }
474}