Package org.eclipse.collections.impl.map.mutable.primitive

Class AbstractMutableIntKeySet

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntKeySet

All Implemented Interfaces:

Externalizable, Serializable, MutableIntCollection, IntIterable, PrimitiveIterable, IntSet, MutableIntSet

public abstract class AbstractMutableIntKeySet
extends Object
implements MutableIntSet, Externalizable

This file was automatically generated from template file abstractMutablePrimitiveKeySet.stg.

Since:

6.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractMutableIntKeySet()

Method Summary

Modifier and Type	Method	Description
boolean	add(int element)
boolean	addAll(int... source)
boolean	addAll(IntIterable source)
boolean	allSatisfy(IntPredicate predicate)	Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(IntPredicate predicate)	Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIntIterable	asLazy()	Returns a LazyIntIterable adapter wrapping the source IntIterable.
MutableIntSet	asSynchronized()
MutableIntSet	asUnmodifiable()
double	average()
LazyIterable<IntIntPair>	cartesianProduct(IntSet set)	Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
RichIterable<IntIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableSet<V>	collect(IntToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	contains(int value)	Returns true if the value is contained in the IntIterable, and false if it is not.
boolean	containsAll(int... source)	Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.
boolean	containsAll(IntIterable source)	Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.
int	count(IntPredicate predicate)	Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
int	detectIfNone(IntPredicate predicate, int ifNone)
void	each(IntProcedure procedure)	A synonym for forEach.
boolean	equals(Object obj)	Follows the same general contract as Set.equals(Object).
int	hashCode()	Follows the same general contract as Set.hashCode().
<T> T	injectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
int	max()
int	maxIfEmpty(int defaultValue)
double	median()
int	min()
int	minIfEmpty(int defaultValue)
boolean	notEmpty()	The English equivalent of !this.isEmpty()
void	readExternal(ObjectInput in)
MutableIntSet	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
boolean	remove(int key)
boolean	removeAll(int... source)
boolean	removeAll(IntIterable source)
MutableIntSet	select(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
int	size()	Returns the number of items in this iterable.
long	sum()
int[]	toArray()	Converts the IntIterable to a primitive int array.
int[]	toArray(int[] result)	Converts the IntIterable to a primitive int array.
MutableIntBag	toBag()	Converts the IntIterable to a new MutableIntBag.
ImmutableIntSet	toImmutable()	Returns an immutable copy of this set.
MutableIntList	toList()	Converts the IntIterable to a new MutableIntList.
MutableIntSet	toSet()	Converts the IntIterable to a new MutableIntSet.
int[]	toSortedArray()
MutableIntList	toSortedList()
String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
MutableIntSet	with(int element)
MutableIntSet	withAll(IntIterable elements)
MutableIntSet	without(int element)
MutableIntSet	withoutAll(IntIterable elements)
void	writeExternal(ObjectOutput out)
Object	writeReplace()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.IntIterable

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.set.primitive.IntSet

isProperSubsetOf, isSubsetOf

Methods inherited from interface org.eclipse.collections.api.collection.primitive.MutableIntCollection

intIterator, removeIf, retainAll, retainAll

Methods inherited from interface org.eclipse.collections.api.set.primitive.MutableIntSet

difference, freeze, intersect, newEmpty, symmetricDifference, tap, union

Constructor Details

AbstractMutableIntKeySet

public AbstractMutableIntKeySet()

Method Details

each

public void each(IntProcedure procedure)

Description copied from interface: IntIterable

A synonym for forEach.

Specified by:

each in interface IntIterable

Since:

7.0.

count

public int count(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a count of the number of elements in the IntIterable that return true for the specified predicate.

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface IntIterable

add

public boolean add(int element)

Specified by:

add in interface MutableIntCollection

addAll

public boolean addAll(int... source)

Specified by:

addAll in interface MutableIntCollection

addAll

public boolean addAll(IntIterable source)

Specified by:

addAll in interface MutableIntCollection

select

public MutableIntSet select(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.

Specified by:

select in interface IntIterable

Specified by:

select in interface IntSet

Specified by:

select in interface MutableIntCollection

Specified by:

select in interface MutableIntSet

reject

public MutableIntSet reject(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.

Specified by:

reject in interface IntIterable

Specified by:

reject in interface IntSet

Specified by:

reject in interface MutableIntCollection

Specified by:

reject in interface MutableIntSet

with

public MutableIntSet with(int element)

Specified by:

with in interface MutableIntCollection

Specified by:

with in interface MutableIntSet

without

public MutableIntSet without(int element)

Specified by:

without in interface MutableIntCollection

Specified by:

without in interface MutableIntSet

withAll

public MutableIntSet withAll(IntIterable elements)

Specified by:

withAll in interface MutableIntCollection

Specified by:

withAll in interface MutableIntSet

withoutAll

public MutableIntSet withoutAll(IntIterable elements)

Specified by:

withoutAll in interface MutableIntCollection

Specified by:

withoutAll in interface MutableIntSet

collect

public <V> MutableSet<V> collect(IntToObjectFunction<? extends V> function)

Description copied from interface: IntIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface IntIterable

Specified by:

collect in interface IntSet

Specified by:

collect in interface MutableIntCollection

Specified by:

collect in interface MutableIntSet

remove

public boolean remove(int key)

Specified by:

remove in interface MutableIntCollection

removeAll

public boolean removeAll(IntIterable source)

Specified by:

removeAll in interface MutableIntCollection

removeAll

public boolean removeAll(int... source)

Specified by:

removeAll in interface MutableIntCollection

clear

public void clear()

Specified by:

clear in interface MutableIntCollection

detectIfNone

public int detectIfNone(IntPredicate predicate,
 int ifNone)

Specified by:

detectIfNone in interface IntIterable

asUnmodifiable

public MutableIntSet asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntCollection

Specified by:

asUnmodifiable in interface MutableIntSet

asSynchronized

public MutableIntSet asSynchronized()

Specified by:

asSynchronized in interface MutableIntCollection

Specified by:

asSynchronized in interface MutableIntSet

sum

public long sum()

Specified by:

sum in interface IntIterable

max

public int max()

Specified by:

max in interface IntIterable

maxIfEmpty

public int maxIfEmpty(int defaultValue)

Specified by:

maxIfEmpty in interface IntIterable

min

public int min()

Specified by:

min in interface IntIterable

minIfEmpty

public int minIfEmpty(int defaultValue)

Specified by:

minIfEmpty in interface IntIterable

average

public double average()

Specified by:

average in interface IntIterable

median

public double median()

Specified by:

median in interface IntIterable

toSortedArray

public int[] toSortedArray()

Specified by:

toSortedArray in interface IntIterable

toSortedList

public MutableIntList toSortedList()

Specified by:

toSortedList in interface IntIterable

toArray

public int[] toArray()

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array.

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] result)

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface IntIterable

contains

public boolean contains(int value)

Description copied from interface: IntIterable

Returns true if the value is contained in the IntIterable, and false if it is not.

Specified by:

contains in interface IntIterable

containsAll

public boolean containsAll(int... source)

Description copied from interface: IntIterable

Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.

Specified by:

containsAll in interface IntIterable

containsAll

public boolean containsAll(IntIterable source)

Description copied from interface: IntIterable

Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.

Specified by:

containsAll in interface IntIterable

cartesianProduct

public LazyIterable<IntIntPair> cartesianProduct(IntSet set)

Description copied from interface: IntSet

Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.

Specified by:

cartesianProduct in interface IntSet

toList

public MutableIntList toList()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntList.

Specified by:

toList in interface IntIterable

toSet

public MutableIntSet toSet()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntSet.

Specified by:

toSet in interface IntIterable

toBag

public MutableIntBag toBag()

Description copied from interface: IntIterable

Converts the IntIterable to a new MutableIntBag.

Specified by:

toBag in interface IntIterable

asLazy

public LazyIntIterable asLazy()

Description copied from interface: IntIterable

Returns a LazyIntIterable adapter wrapping the source IntIterable.

Specified by:

asLazy in interface IntIterable

injectInto

public <T> T injectInto(T injectedValue,
 ObjectIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface IntIterable

toImmutable

public ImmutableIntSet toImmutable()

Description copied from interface: MutableIntSet

Returns an immutable copy of this set.

Specified by:

toImmutable in interface IntSet

Specified by:

toImmutable in interface MutableIntCollection

Specified by:

toImmutable in interface MutableIntSet

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

equals

public boolean equals(Object obj)

Description copied from interface: IntSet

Follows the same general contract as Set.equals(Object).

Specified by:

equals in interface IntSet

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: IntSet

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface IntSet

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

 Assert.assertEquals("[]", IntLists.mutable.empty().toString());
 Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Description copied from interface: IntIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface IntIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.

writeReplace

public Object writeReplace()
                    throws ObjectStreamException

Throws:

ObjectStreamException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException