Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.collect.ImmutableEnumSet

Modifier and Type	Class and Description
private static class	ImmutableEnumSet.EnumSerializedForm<E extends Enum<E>>

Modifier and Type	Field and Description
private final transient EnumSet<E>	delegate
private transient int	hashCode

Access	Constructor and Description
private	ImmutableEnumSet(EnumSet<E> delegate)

Method Summary

Modifier and Type	Method and Description
pack-priv static <E extends Enum<E>> ImmutableSet<E>	asImmutable(EnumSet<E> set)
public boolean	contains(Object element whose presence in this set is to be tested object) Implements abstract com.google.common.collect.ImmutableCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this set collection) Overrides java.util.AbstractCollection.containsAll. Implements java.util.Set.containsAll, java.util.Collection.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
public boolean	equals(Object object to be compared for equality with this set object) Overrides com.google.common.collect.ImmutableSet.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality.
public void	forEach(Consumer<? super E> The action to be performed for each element action) Overrides default java.lang.Iterable.forEach. Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception.
public int	hashCode() Overrides com.google.common.collect.ImmutableSet.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Returns the hash code value for this set.
public boolean	isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Returns `true` if this set contains no elements.
pack-priv boolean	isHashCodeFast() Overrides com.google.common.collect.ImmutableSet.isHashCodeFast. Returns `true` if the `hashCode()` method runs quickly.
pack-priv boolean	isPartialView() Implements abstract com.google.common.collect.ImmutableCollection.isPartialView. Returns `true` if this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods.
public UnmodifiableIterator<E>	iterator() Implements abstract com.google.common.collect.ImmutableSet.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
private void	readObject(ObjectInputStream stream) Hides com.google.common.collect.ImmutableSet.readObject.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).
public Spliterator<E>	spliterator() Overrides com.google.common.collect.ImmutableCollection.spliterator. Overrides default java.util.Set.spliterator, java.util.Collection.spliterator. Creates a `Spliterator` over the elements in this set.
public String	toString() Overrides java.util.AbstractCollection.toString. Returns a string representation of this collection.
pack-priv Object	writeReplace() Overrides com.google.common.collect.ImmutableSet.writeReplace.

Inherited from com.google.common.collect.ImmutableSet:: builder builderWithExpectedSize chooseTableSize copyOf copyOf copyOf copyOf of of of of of of of toImmutableSet

delegate	back to summary
private final transient EnumSet<E> delegate

hashCode	back to summary
private transient int hashCode Annotations @LazyInit

ImmutableEnumSet	back to summary
private ImmutableEnumSet(EnumSet<E> delegate)

Method Detail

asImmutable	back to summary
pack-priv static <E extends Enum<E>> ImmutableSet<E> asImmutable(EnumSet<E> set)

contains back to summary

contains	back to summary
public boolean contains(Object object) Implements abstract com.google.common.collect.ImmutableCollection.contains. Implements java.util.Set.contains, java.util.Collection.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters object:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element Annotations @Override

public boolean contains(Object object)

Implements abstract com.google.common.collect.ImmutableCollection.contains.

Implements java.util.Set.contains, java.util.Collection.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

object:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

Annotations

@Override

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> collection) Overrides java.util.AbstractCollection.containsAll. Implements java.util.Set.containsAll, java.util.Collection.containsAll. Doc from java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns `true` if it is a subset of this set. Parameters collection:Collection<?> collection to be checked for containment in this set Returns:boolean `true` if this set contains all of the elements of the specified collection Annotations @Override

public boolean containsAll(Collection<?> collection)

Overrides java.util.AbstractCollection.containsAll.

Implements java.util.Set.containsAll, java.util.Collection.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters

collection:Collection<?>: collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides com.google.common.collect.ImmutableSet.equals. Implements java.util.Set.equals, java.util.Collection.equals. Doc from java.util.Set.equals. Compares the specified object with this set for equality. Returns `true` if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface. Parameters object:Object object to be compared for equality with this set Returns:boolean `true` if the specified object is equal to this set Annotations @Override

public boolean equals(Object object)

Overrides com.google.common.collect.ImmutableSet.equals.

Implements java.util.Set.equals, java.util.Collection.equals.

Doc from java.util.Set.equals.

Compares the specified object with this set for equality. Returns true if the specified object is also a set, the two sets have the same size, and every member of the specified set is contained in this set (or equivalently, every member of this set is contained in the specified set). This definition ensures that the equals method works properly across different implementations of the set interface.

Parameters

object:Object: object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

Annotations

@Override

forEach back to summary

forEach	back to summary
public void forEach(Consumer<? super E> action) Overrides default java.lang.Iterable.forEach. Doc from java.lang.Iterable.forEach. Performs the given action for each element of the `Iterable` until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller. The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy. Parameters action:Consumer<? super E> The action to be performed for each element Annotations @Override

public void forEach(Consumer<? super E> action)

Overrides default java.lang.Iterable.forEach.

Doc from java.lang.Iterable.forEach.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.

The behavior of this method is unspecified if the action performs side-effects that modify the underlying source of elements, unless an overriding class has specified a concurrent modification policy.

Parameters

action:Consumer<? super E>: The action to be performed for each element

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides com.google.common.collect.ImmutableSet.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Doc from java.util.Set.hashCode. Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a `null` element is defined to be zero. This ensures that `s1.equals(s2)` implies that `s1.hashCode()==s2.hashCode()` for any two sets `s1` and `s2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this set Annotations @Override

public int hashCode()

Overrides com.google.common.collect.ImmutableSet.hashCode.

Implements java.util.Set.hashCode, java.util.Collection.hashCode.

Doc from java.util.Set.hashCode.

Returns the hash code value for this set. The hash code of a set is defined to be the sum of the hash codes of the elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this set

Annotations

@Override

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Set.isEmpty, java.util.Collection.isEmpty. Doc from java.util.Set.isEmpty. Returns `true` if this set contains no elements. Returns:boolean `true` if this set contains no elements Annotations @Override

public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.Set.isEmpty, java.util.Collection.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

Annotations

@Override

isHashCodeFast back to summary

isHashCodeFast	back to summary
pack-priv boolean isHashCodeFast() Overrides com.google.common.collect.ImmutableSet.isHashCodeFast. Doc from com.google.common.collect.ImmutableSet.isHashCodeFast. Returns `true` if the `hashCode()` method runs quickly. Annotations @Override

pack-priv boolean isHashCodeFast()

Overrides com.google.common.collect.ImmutableSet.isHashCodeFast.

Doc from com.google.common.collect.ImmutableSet.isHashCodeFast.

Returns true if the hashCode() method runs quickly.

Annotations

@Override

isPartialView back to summary

isPartialView	back to summary
pack-priv boolean isPartialView() Implements abstract com.google.common.collect.ImmutableCollection.isPartialView. Doc from com.google.common.collect.ImmutableCollection.isPartialView. Returns `true` if this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods. This is generally used to determine whether `copyOf` implementations should make an explicit copy to avoid memory leaks. Annotations @Override

pack-priv boolean isPartialView()

Implements abstract com.google.common.collect.ImmutableCollection.isPartialView.

Doc from com.google.common.collect.ImmutableCollection.isPartialView.

Returns true if this immutable collection's implementation contains references to user-created objects that aren't accessible via this collection's methods. This is generally used to determine whether copyOf implementations should make an explicit copy to avoid memory leaks.

Annotations

@Override

iterator	back to summary
public UnmodifiableIterator<E> iterator() Implements abstract com.google.common.collect.ImmutableSet.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:UnmodifiableIterator<E> an iterator over the elements in this set Annotations @Override

iterator

back to summary

public UnmodifiableIterator<E> iterator()

Implements abstract com.google.common.collect.ImmutableSet.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:UnmodifiableIterator<E>

an iterator over the elements in this set

Annotations

@Override

readObject	back to summary
private void readObject(ObjectInputStream stream) throws InvalidObjectException Hides com.google.common.collect.ImmutableSet.readObject. Annotations @J2ktIncompatible

readObject

back to summary

private void readObject(ObjectInputStream stream) throws InvalidObjectException

Hides com.google.common.collect.ImmutableSet.readObject.

Annotations

@J2ktIncompatible

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality) Annotations @Override

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

spliterator back to summary

spliterator	back to summary
public Spliterator<E> spliterator() Overrides com.google.common.collect.ImmutableCollection.spliterator. Overrides default java.util.Set.spliterator, java.util.Collection.spliterator. Doc from java.util.Set.spliterator. Creates a `Spliterator` over the elements in this set. The `Spliterator` reports `Spliterator#DISTINCT`. Implementations should document the reporting of additional characteristic values. Returns:Spliterator<E> a `Spliterator` over the elements in this set Annotations @Override

public Spliterator<E> spliterator()

Overrides com.google.common.collect.ImmutableCollection.spliterator.

Overrides default java.util.Set.spliterator, java.util.Collection.spliterator.

Doc from java.util.Set.spliterator.

Creates a Spliterator over the elements in this set.

The Spliterator reports Spliterator#DISTINCT. Implementations should document the reporting of additional characteristic values.

Returns:Spliterator<E>

a Spliterator over the elements in this set

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.util.AbstractCollection.toString. Doc from java.util.AbstractCollection.toString. Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets (`"[]"`). Adjacent elements are separated by the characters `", "` (comma and space). Elements are converted to strings as by `String#valueOf(Object)`. Returns:String a string representation of this collection Annotations @Override

public String toString()

Overrides java.util.AbstractCollection.toString.

Doc from java.util.AbstractCollection.toString.

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf(Object).

Returns:String

a string representation of this collection

Annotations

@Override

writeReplace	back to summary
pack-priv Object writeReplace() Overrides com.google.common.collect.ImmutableSet.writeReplace. Annotations @Override @J2ktIncompatible

writeReplace

back to summary

pack-priv Object writeReplace()

Overrides com.google.common.collect.ImmutableSet.writeReplace.

Annotations

@Override
@J2ktIncompatible

pack-priv final Class ImmutableEnumSet<E extends java.lang.Enum<E>>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ImmutableEnumSet.EnumSerializedForm<E extends java.lang.Enum<E>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
pack-priv final EnumSet<E>	delegate
private static final long	serialVersionUID