com.carrotsearch.hppcrt.CharSet Maven / Gradle / Ivy

Go to download
package com.carrotsearch.hppcrt;

import com.carrotsearch.hppcrt.CharCollection;
import com.carrotsearch.hppcrt.cursors.CharCursor;

/**
 * A set of chars.
 */
 @javax.annotation.Generated(
    date = "2016-01-30T23:09:29+0100",
    value = "KTypeSet.java") 
public interface CharSet extends CharCollection
{
    /**
     * Adds k to the set.
     * 
     * @return Returns true if this element was not part of the set before. Returns
     * false if an equal element is already part of the set, and leaves the set unchanged. .
     */
    boolean add(char k);

    /**
     * Adds all elements from a given container to this set.
     * 
     * @return Returns the number of elements actually added as a result of this
     *         call (not previously present in the set).
     */
    int addAll(final CharContainer container);

    /**
     * Adds all elements from a given iterable to this set.
     * 
     * @return Returns the number of elements actually added as a result of this
     *         call (not previously present in the set).
     */
    int addAll(final Iterable iterable);

    /**
     * Remove all elements of the set matching key. Returns true
     * if key was present in the set and has been successfully removed.
     * This is indeed an alias for {@code CharCollection.removeAll(key) > 0}
     * @see CharCollection#removeAll
     */
    boolean remove(char key);
}