Class ForwardingSet<E extends @Nullable java.lang.Object>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.collect.ForwardingCollection<E>
-
- com.google.common.collect.ForwardingSet<E>
-
- All Implemented Interfaces:
java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Set<E>
- Direct Known Subclasses:
ForwardingSortedSet
,TypeToken.TypeSet
@GwtCompatible public abstract class ForwardingSet<E extends @Nullable java.lang.Object> extends ForwardingCollection<E> implements java.util.Set<E>
A set which forwards all its method calls to another set. Subclasses should override one or more methods to modify the behavior of the backing set as desired per the decorator pattern.Warning: The methods of
ForwardingSet
forward indiscriminately to the methods of the delegate. For example, overridingForwardingCollection.add(E)
alone will not change the behavior ofForwardingCollection.addAll(java.util.Collection<? extends E>)
, which can lead to unexpected behavior. In this case, you should overrideaddAll
as well, either providing your own implementation, or delegating to the providedstandardAddAll
method.default
method warning: This class does not forward calls todefault
methods. Instead, it inherits their default implementations. When those implementations invoke methods, they invoke methods on theForwardingSet
.The
standard
methods are not guaranteed to be thread-safe, even when all of the methods that they depend on are thread-safe.- Since:
- 2.0
- Author:
- Kevin Bourrillion, Louis Wasserman
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingSet()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract java.util.Set<E>
delegate()
Returns the backing delegate instance that methods are forwarded to.boolean
equals(java.lang.Object object)
int
hashCode()
protected boolean
standardEquals(java.lang.Object object)
A sensible definition ofequals(java.lang.Object)
in terms ofForwardingCollection.size()
andForwardingCollection.containsAll(java.util.Collection<?>)
.protected int
standardHashCode()
A sensible definition ofhashCode()
in terms ofForwardingCollection.iterator()
.protected boolean
standardRemoveAll(java.util.Collection<?> collection)
A sensible definition ofForwardingCollection.removeAll(java.util.Collection<?>)
in terms ofForwardingCollection.iterator()
andForwardingCollection.remove(java.lang.Object)
.-
Methods inherited from class com.google.common.collect.ForwardingCollection
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
-
-
-
Constructor Detail
-
ForwardingSet
protected ForwardingSet()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract java.util.Set<E> delegate()
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asdelegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingCollection<E extends @Nullable java.lang.Object>
-
equals
public boolean equals(@CheckForNull java.lang.Object object)
-
hashCode
public int hashCode()
-
standardRemoveAll
protected boolean standardRemoveAll(java.util.Collection<?> collection)
A sensible definition ofForwardingCollection.removeAll(java.util.Collection<?>)
in terms ofForwardingCollection.iterator()
andForwardingCollection.remove(java.lang.Object)
. If you overrideiterator
orremove
, you may wish to overrideForwardingCollection.removeAll(java.util.Collection<?>)
to forward to this implementation.- Overrides:
standardRemoveAll
in classForwardingCollection<E extends @Nullable java.lang.Object>
- Since:
- 7.0 (this version overrides the
ForwardingCollection
version as of 12.0)
-
standardEquals
protected boolean standardEquals(@CheckForNull java.lang.Object object)
A sensible definition ofequals(java.lang.Object)
in terms ofForwardingCollection.size()
andForwardingCollection.containsAll(java.util.Collection<?>)
. If you override either of those methods, you may wish to overrideequals(java.lang.Object)
to forward to this implementation.- Since:
- 7.0
-
standardHashCode
protected int standardHashCode()
A sensible definition ofhashCode()
in terms ofForwardingCollection.iterator()
. If you overrideForwardingCollection.iterator()
, you may wish to overrideequals(java.lang.Object)
to forward to this implementation.- Since:
- 7.0
-
-