com.google.common.collect

public Interface Interner<E>

Known Direct Implementers

com.google.common.collect.Interners.InternerImpl

Annotations

@DoNotMock:Use Interners.new*Interner
@J2ktIncompatible
@GwtIncompatible
@ElementTypesAreNonnullByDefault

Imports

com.google.common.annotations.GwtIncompatible, .J2ktIncompatible, com.google.errorprone.annotations.DoNotMock

Provides similar behavior to String#intern for any immutable type. Common implementations are available from the Interners class.

Note that String.intern() has some well-known performance limitations, and should generally be avoided. Prefer Interners#newWeakInterner or another Interner implementation even for String interning.

Author: Kevin Bourrillion
Since: 3.0

Method Summary

Modifier and Type	Method and Description
public E	intern(E sample) Chooses and returns the representative instance for any of a collection of instances that are equal to each other.

Method Detail

intern back to summary

intern	back to summary
public E intern(E sample) Chooses and returns the representative instance for any of a collection of instances that are equal to each other. If two equal inputs are given to this method, both calls will return the same instance. That is, `intern(a).equals(a)` always holds, and `intern(a) == intern(b)` if and only if `a.equals(b)`. Note that `intern(a)` is permitted to return one instance now and a different instance later if the original interned instance was garbage-collected. Warning do not use with mutable objects. Exceptions NullPointerException: if `sample` is null

public E intern(E sample)

Chooses and returns the representative instance for any of a collection of instances that are equal to each other. If two equal inputs are given to this method, both calls will return the same instance. That is, intern(a).equals(a) always holds, and intern(a) == intern(b) if and only if a.equals(b). Note that intern(a) is permitted to return one instance now and a different instance later if the original interned instance was garbage-collected.

Warning

do not use with mutable objects.

Exceptions

NullPointerException:: if sample is null