AbstractArraySet

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jjoost.collections.sets.base
Class AbstractArraySet<V>

java.lang.Object
  org.jjoost.collections.sets.base.AbstractArraySet<V>

All Implemented Interfaces:: java.io.Serializable, java.lang.Iterable<V>, AnyReadSet<V>, AnySet<V>, Function<V,java.lang.Boolean>

Direct Known Subclasses:: ArraySet, MultiArraySet

public abstract class AbstractArraySet<V>
extends java.lang.Object
implements AnySet<V>
extends java.lang.Object
implements AnySet<V>

See Also:: Serialized Form

Constructor Summary
`AbstractArraySet(int initialCapacity)`
`AbstractArraySet(int initialCapacity, Equality<? super V> valEq)`

Method Summary
`java.lang.Boolean`	`apply(V v)` Returns the result of applying the function to the parameter
`int`	`clear()` Removes all values from the set and return the number of values removed.
`java.util.Iterator<V>`	`clearAndReturn()` Removes all values from the set and returns an `Iterator` over them.
`boolean`	`contains(V v)` Returns a `boolean` indicating if the parameter occurs in the set at least once.
`int`	`count(V v)` Returns an integer representing the number of occurrences of the value in the set
`Equality<? super V>`	`equality()` Returns an object that represents the definition of equality used by this set
`V`	`first(V v)` The first value stored in the set that is equal to the provided value, as determined by any provided `Equality` or `Comparator`.
`boolean`	`isEmpty()` Indicates if the set is empty
`java.util.Iterator<V>`	`iterator()`
`V`	`putIfAbsent(V v)` Inserts the value and returns `null` if an equal value does not already occur in the set; otherwise returns the first such value encountered
`int`	`remove(V value)` Removes all occurrences of values equal to the parameter from the set, as determined by the set's definition of equality and returns the number of values that were removed from the set.
`int`	`remove(V v, int atMost)` Removes at most the prescribed number of values equal to the parameter from the set; which values are removed is implementation specific, and may be arbitrary.
`java.lang.Iterable<V>`	`removeAndReturn(V value)` Removes all occurrences of values equal to the parameter and returns an `Iterable` of the values removed.
`java.lang.Iterable<V>`	`removeAndReturn(V v, int atMost)` Removes at most the prescribed number of values equal to the parameter from the set and returns them to the user; which values are removed is implementation specific, and may be arbitrary.
`V`	`removeAndReturnFirst(V value)` Removes all occurrences of values equal to the parameter from the set, as determined by the set's definition of equality, and returns the first value encountered or null if none.
`V`	`removeAndReturnFirst(V v, int atMost)` Removes at most the prescribed number of values equal to the parameter from the set and returns the first one encountered to the user, or null if none; which values are removed is implementation specific, and may be arbitrary.
`void`	`shrink()` This method attempts to minimise the resource utilisation of the set.
`int`	`totalCount()` Returns the total number of values (including duplicates) in the set

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.jjoost.collections.AnySet
`add, copy, put, putAll, unique`

Methods inherited from interface org.jjoost.collections.AnyReadSet
`all, list, permitsDuplicates, uniqueCount`

Constructor Detail

AbstractArraySet

public AbstractArraySet(int initialCapacity)

AbstractArraySet

public AbstractArraySet(int initialCapacity,
                        Equality<? super V> valEq)

Method Detail