Package com.google.common.collect

Class ImmutableSet.Builder<E>

java.lang.Object
com.google.common.collect.ImmutableCollection.Builder<E>
com.google.common.collect.ImmutableSet.Builder<E>
Direct Known Subclasses:
ImmutableSortedSet.Builder
Enclosing class:
ImmutableSet<E>
@Deprecated(since="2022-12-01") public static class ImmutableSet.Builder<E> extends ImmutableCollection.Builder<E>
Deprecated.
The Google Guava Core Libraries are deprecated and will not be part of the AEM SDK after April 2023
A builder for creating immutable set instances, especially public static final sets ("constant sets"). Example: 
   

    public static final ImmutableSet<Color> GOOGLE_COLORS =
        new ImmutableSet.Builder<Color>()
            .addAll(WEBSAFE_COLORS)
            .add(new Color(0, 191, 255))
            .build();

Builder instances can be reused; it is safe to call build() multiple times to build multiple sets in series. Each set is a superset of the set created before it.

Since:
2.0 (imported from Google Collections Library)

  • Constructor Summary

    Constructors
    Constructor
    Description
    Builder()
    Deprecated.
    Creates a new builder.

  • Method Summary

    Modifier and Type
    Method
    Description
    ImmutableSet.Builder<E>
    add(E element)
    Deprecated.
    Adds element to the ImmutableSet.
    ImmutableSet.Builder<E>
    add(E... elements)
    Deprecated.
    Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
    ImmutableSet.Builder<E>
    addAll(Iterable<? extends E> elements)
    Deprecated.
    Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
    ImmutableSet.Builder<E>
    addAll(Iterator<? extends E> elements)
    Deprecated.
    Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
    ImmutableSet<E>
    build()
    Deprecated.
    Returns a newly-created ImmutableSet based on the contents of the Builder.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Builder

      public Builder()
      Deprecated.
      Creates a new builder. The returned builder is equivalent to the builder generated by ImmutableSet.builder().

  • Method Details

    • add

      public ImmutableSet.Builder<E> add(E element)
      Deprecated.
      Adds element to the ImmutableSet. If the ImmutableSet already contains element, then add has no effect (only the previously added element is retained).
      Parameters:
      element - the element to add
      Returns:
      this Builder object
      Throws:
      NullPointerException - if element is null

    • add

      public ImmutableSet.Builder<E> add(E... elements)
      Deprecated.
      Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
      Parameters:
      elements - the elements to add
      Returns:
      this Builder object
      Throws:
      NullPointerException - if elements is null or contains a null element

    • addAll

      public ImmutableSet.Builder<E> addAll(Iterable<? extends E> elements)
      Deprecated.
      Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
      Parameters:
      elements - the Iterable to add to the ImmutableSet
      Returns:
      this Builder object
      Throws:
      NullPointerException - if elements is null or contains a null element

    • addAll

      public ImmutableSet.Builder<E> addAll(Iterator<? extends E> elements)
      Deprecated.
      Adds each element of elements to the ImmutableSet, ignoring duplicate elements (only the first duplicate element is added).
      Overrides:
      addAll in class ImmutableCollection.Builder<E>
      Parameters:
      elements - the elements to add to the ImmutableSet
      Returns:
      this Builder object
      Throws:
      NullPointerException - if elements is null or contains a null element

    • build

      public ImmutableSet<E> build()
      Deprecated.
      Returns a newly-created ImmutableSet based on the contents of the Builder.
      Specified by:
      build in class ImmutableCollection.Builder<E>