com.koloboke.collect.set
Interface CharSet

All Superinterfaces:

CharCollection, Collection<Character>, Container, Iterable<Character>, Set<Character>

All Known Subinterfaces:

HashCharSet

public interface CharSet
extends CharCollection, Set<Character>

A Set specialization with char elements.

Methods, declared in this interface (i. e. not inherited from the superinterfaces), are present only to remove some compile-time ambiguities, they don't have any additional meaning over the specifications from superinterfaces.

See Also:

CharSetFactory, @KolobokeSet

Method Summary

boolean	add(Character e) Deprecated. Use specialization CharCollection.add(char) instead
CharIterator	iterator() Deprecated. Instead of explicit iterator() calls, use CharCollection.cursor(); iterator() is still sensible only as a backing mechanism for Java 5's for-each statements.

Methods inherited from interface com.koloboke.collect.CharCollection

add, contains, contains, cursor, forEach, forEachWhile, remove, removeChar, removeIf, toArray, toArray, toArray, toCharArray

Methods inherited from interface com.koloboke.collect.Container

clear, ensureCapacity, isEmpty, shrink, size, sizeAsLong

Methods inherited from interface Set

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

@Deprecated
boolean add(@Nonnull
                       Character e)

Deprecated. Use specialization CharCollection.add(char) instead

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface CharCollection

Specified by:

add in interface Collection<Character>

Specified by:

add in interface Set<Character>

Parameters:

e - element whose presence in this collection is to be ensured

Returns:

true if this collection changed as a result of the call

iterator

@Deprecated
@Nonnull
CharIterator iterator()

Deprecated. Instead of explicit iterator() calls, use CharCollection.cursor(); iterator() is still sensible only as a backing mechanism for Java 5's for-each statements.

Returns a new iterator over this collection's elements.

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface Collection<Character>

Specified by:

iterator in interface Iterable<Character>

Specified by:

iterator in interface Set<Character>

Returns:

a new iterator over this collection's elements

See Also:

Comparison of iteration options in the library