Apache Commons Collections 4.4 · org.apache.commons.collections4.set.TransformedSet

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides org.apache.commons.collections4.collection.TransformedCollection.serialVersionUID. Serialization version

Access	Constructor and Description
protected	TransformedSet(final Set<E> the set to decorate, must not be null set, final Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null transformer) Constructor that wraps (not copies).

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object object to be compared for equality with this set object) Overrides java.lang.Object.equals. Implements java.util.Set.equals, java.util.Collection.equals. Compares the specified object with this set for equality.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode, java.util.Collection.hashCode. Returns the hash code value for this set.
public static < the element type E> Set<E>	Returns: a new transformed set transformedSet(final Set<E> the set to decorate, must not be null set, final Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null transformer) Factory method to create a transforming set that will transform existing contents of the specified set.
public static < the element type E> TransformedSet<E>	Returns: a new transformed set transformingSet(final Set<E> the set to decorate, must not be null set, final Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null transformer) Factory method to create a transforming set.

Inherited from org.apache.commons.collections4.collection.TransformedCollection:: add addAll transform transform transformedCollection transformingCollection

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.apache.commons.collections4.collection.TransformedCollection.serialVersionUID. Serialization version

TransformedSet	back to summary
protected TransformedSet(final Set<E> set, final Transformer<? super E, ? extends E> transformer) Constructor that wraps (not copies). If there are any elements already in the set being decorated, they are NOT transformed. Parameters set:Set<E> the set to decorate, must not be null transformer:Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null Exceptions NullPointerException: if set or transformer is null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object object) Overrides java.lang.Object.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(final Object object)

Overrides java.lang.Object.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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.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 java.lang.Object.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

transformedSet back to summary

transformedSet	back to summary
public static <E> Set<E> transformedSet(final Set<E> set, final Transformer<? super E, ? extends E> transformer) Factory method to create a transforming set that will transform existing contents of the specified set. If there are any elements already in the set being decorated, they will be transformed by this method. Contrast this with `transformingSet(Set, Transformer)`. Parameters <E> the element type set:Set<E> the set to decorate, must not be null transformer:Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null Returns:Set<E> a new transformed set Exceptions NullPointerException: if set or transformer is null Since 4.0

public static <E> Set<E> transformedSet(final Set<E> set, final Transformer<? super E, ? extends E> transformer)

Factory method to create a transforming set that will transform existing contents of the specified set.

If there are any elements already in the set being decorated, they will be transformed by this method. Contrast this with transformingSet(Set, Transformer).

Parameters

<E>: the element type
set:Set<E>: the set to decorate, must not be null
transformer:Transformer<? super E, ? extends E>: the transformer to use for conversion, must not be null

Returns:Set<E>

a new transformed set

Exceptions

NullPointerException:: if set or transformer is null

Since

4.0

transformingSet back to summary

transformingSet	back to summary
public static <E> TransformedSet<E> transformingSet(final Set<E> set, final Transformer<? super E, ? extends E> transformer) Factory method to create a transforming set. If there are any elements already in the set being decorated, they are NOT transformed. Contrast this with `transformedSet(Set, Transformer)`. Parameters <E> the element type set:Set<E> the set to decorate, must not be null transformer:Transformer<? super E, ? extends E> the transformer to use for conversion, must not be null Returns:TransformedSet<E> a new transformed set Exceptions NullPointerException: if set or transformer is null Since 4.0

public static <E> TransformedSet<E> transformingSet(final Set<E> set, final Transformer<? super E, ? extends E> transformer)

Factory method to create a transforming set.

If there are any elements already in the set being decorated, they are NOT transformed. Contrast this with transformedSet(Set, Transformer).

Parameters

<E>: the element type
set:Set<E>: the set to decorate, must not be null
transformer:Transformer<? super E, ? extends E>: the transformer to use for conversion, must not be null

Returns:TransformedSet<E>

a new transformed set

Exceptions

NullPointerException:: if set or transformer is null

Since

4.0

public Class TransformedSet<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail