org.javimmutable.collections.JImmutableSet Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2014, Burton Computer Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//
//     Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//
//     Neither the name of the Burton Computer Corporation nor the names
//     of its contributors may be used to endorse or promote products
//     derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package org.javimmutable.collections;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.util.Collection;
import java.util.Iterator;
import java.util.Set;

/**
 * Interface for immutable sets.
 *
 * @param 
 */
@SuppressWarnings("ClassWithTooManyMethods")
@Immutable
public interface JImmutableSet
        extends Insertable,
                Cursorable,
                Iterable
{
    /**
     * Adds the single value to the Set.
     *
     * @param value
     * @return instance of set containing the value
     */
    @Nonnull
    JImmutableSet insert(@Nonnull T value);

    /**
     * Determines if the Set contains the specified value.
     *
     * @param value
     * @return true if the Set contains the value
     */
    boolean contains(@Nullable T value);

    /**
     * Determines if the Set contains all values in the specified collection.
     *
     * @param values
     * @return true if the Set contains the values
     */
    boolean containsAll(@Nonnull Cursorable values);

    /**
     * Determines if the Set contains all values in the specified collection.
     *
     * @param values
     * @return true if the Set contains the values
     */
    boolean containsAll(@Nonnull Collection values);

    /**
     * Determines if the Set contains all values in the specified collection.
     *
     * @param values
     * @return true if the Set contains the values
     */
    boolean containsAll(@Nonnull Cursor values);

    /**
     * Determines if the Set contains all values in the specified collection.
     *
     * @param values
     * @return true if the Set contains the values
     */
    boolean containsAll(@Nonnull Iterator values);

    /**
     * Determines if the Set contains any values in the specified collection.
     *
     * @param values
     * @return true if the Set contains a value
     */
    boolean containsAny(@Nonnull Cursorable values);

    /**
     * Determines if the Set contains any values in the specified collection.
     *
     * @param values
     * @return true if the Set contains a value
     */
    boolean containsAny(@Nonnull Collection values);

    /**
     * Determines if the Set contains any values in the specified collection.
     *
     * @param values
     * @return true if the Set contains a value
     */
    boolean containsAny(@Nonnull Cursor values);

    /**
     * Determines if the Set contains any values in the specified collection.
     *
     * @param values
     * @return true if the Set contains a value
     */
    boolean containsAny(@Nonnull Iterator values);

    /**
     * Removes the value from the Set.  Has no effect if the value is not in the Set.
     *
     * @param value
     * @return instance of set without the value
     */
    @Nonnull
    JImmutableSet delete(T value);

    /**
     * Removes all values of other from the Set.  Has no effect if none of the values are in the Set
     *
     * @param other
     * @return instance of set without the values
     */
    @Nonnull
    JImmutableSet deleteAll(@Nonnull Cursorable other);

    /**
     * Removes all values of other from the Set.  Has no effect if none of the values are in the Set
     *
     * @param other
     * @return instance of set without the values
     */
    @Nonnull
    JImmutableSet deleteAll(@Nonnull Collection other);

    /**
     * Removes all values of other from the Set.  Has no effect if none of the values are in the Set
     *
     * @param other
     * @return instance of set without the values
     */
    @Nonnull
    JImmutableSet deleteAll(@Nonnull Cursor other);

    /**
     * Removes all values of other from the Set.  Has no effect if none of the values are in the Set
     *
     * @param other
     * @return instance of set without the values
     */
    @Nonnull
    JImmutableSet deleteAll(@Nonnull Iterator other);

    /**
     * Adds all values from other to the Set.
     *
     * @param other source of values to add
     * @return instance of set containing the values
     */
    @Nonnull
    JImmutableSet union(@Nonnull Cursorable other);

    /**
     * Adds all values from other to the Set.
     *
     * @param other source of values to add
     * @return instance of set containing the values
     */
    @Nonnull
    JImmutableSet union(@Nonnull Collection other);

    /**
     * Adds all values from other to the Set.
     *
     * @param values source of values to add
     * @return instance of set containing the values
     */
    @Nonnull
    JImmutableSet union(@Nonnull Cursor values);

    /**
     * Adds all values from other to the Set.
     *
     * @param values source of values to add
     * @return instance of set containing the values
     */
    @Nonnull
    JImmutableSet union(@Nonnull Iterator values);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param other
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull Cursorable other);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param other
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull Collection other);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param values
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull Cursor values);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param values
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull Iterator values);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param other
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull JImmutableSet other);

    /**
     * Removes all values from the Set that are not contained in the other collection.
     *
     * @param other
     * @return instance of set with unmatched values removed
     */
    @Nonnull
    JImmutableSet intersection(@Nonnull Set other);

    /**
     * Determines the number of values in the Set.
     *
     * @return number of values in the Set
     */
    int size();

    /**
     * @return true only if set contains no values
     */
    boolean isEmpty();

    /**
     * @return an equivalent collection with no values
     */
    @Nonnull
    JImmutableSet deleteAll();

    /**
     * @return an unmodifiable Set implementation backed by this set.
     */
    @Nonnull
    Set getSet();
}