org.javimmutable.collections.JImmutableSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javimmutable-collections Show documentation
Show all versions of javimmutable-collections Show documentation
Library providing immutable/persistent collection classes for
Java. While collections are immutable they provide methods for
adding and removing values by creating new modified copies of
themselves. Each copy shares almost all of its structure with
other copies to minimize memory consumption.
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2019, 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.Arrays;
import java.util.Iterator;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collector;
/**
* Interface for immutable sets.
*/
@SuppressWarnings("ClassWithTooManyMethods")
@Immutable
public interface JImmutableSet
extends Insertable>,
IterableStreamable,
Mapped,
InvariantCheckable
{
interface Builder
{
/**
* Builds and returns a collection containing all of the added values. May be called
* as often as desired and is safe to call and then continue adding more elements to build
* another collection with those additional elements.
*
* @return the collection
*/
@Nonnull
JImmutableSet build();
/**
* Determines how many values will be in the collection if build() is called now.
*/
int size();
/**
* Adds the specified value to the values included in the collection when build() is called.
*
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
Builder add(T value);
/**
* Adds all values in the Iterator to the values included in the collection when build() is called.
*
* @param source Iterator containing values to add
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
default Builder add(Iterator source)
{
while (source.hasNext()) {
add(source.next());
}
return this;
}
/**
* Adds all values in the Collection to the values included in the collection when build() is called.
*
* @param source Collection containing values to add
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
default Builder add(Iterable source)
{
return add(source.iterator());
}
/**
* Adds all values in the array to the values included in the collection when build() is called.
*
* @param source array containing values to add
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
default Builder add(K... source)
{
return add(Arrays.asList(source));
}
/**
* Adds all values in the specified range of Indexed to the values included in the collection when build() is called.
*
* @param source Indexed containing values to add
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
default Builder add(Indexed source,
int offset,
int limit)
{
for (int i = offset; i < limit; ++i) {
add(source.get(i));
}
return this;
}
/**
* Adds all values in the Indexed to the values included in the collection when build() is called.
*
* @param source Indexed containing values to add
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
default Builder add(Indexed source)
{
return add(source, 0, source.size());
}
/**
* Removes all objects and resets the builder to it's initial post-build state.
*
* @return the builder (convenience for chaining multiple calls)
*/
@Nonnull
Builder clear();
}
/**
* Adds the single value to the Set.
*
* @return instance of set containing the value
*/
@Nonnull
@Override
JImmutableSet insert(@Nonnull T value);
/**
* Adds all of the elements of the specified collection to the set.
*
* @return instance of set containing the collection
*/
@Nonnull
@Override
JImmutableSet insertAll(@Nonnull Iterable values);
/**
* Adds all of the elements of the specified collection to the set.
*
* @return instance of set containing the collection
*/
@Nonnull
@Override
JImmutableSet insertAll(@Nonnull Iterator values);
/**
* Determines if the Set contains the specified 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.
*
* @return true if the Set contains the values
*/
boolean containsAll(@Nonnull Iterable values);
/**
* Determines if the Set contains all values in the specified collection.
*
* @return true if the Set contains the values
*/
boolean containsAll(@Nonnull Iterator values);
/**
* Determines if the Set contains any values in the specified collection.
*
* @return true if the Set contains a value
*/
boolean containsAny(@Nonnull Iterable values);
/**
* Determines if the Set contains any values in the specified collection.
*
* @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.
*
* @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
*
* @return instance of set without the values
*/
@Nonnull
JImmutableSet deleteAll(@Nonnull Iterable other);
/**
* Removes all values of other from the Set. Has no effect if none of the values are in the Set
*
* @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 Iterable 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 Iterator values);
/**
* Removes all values from the Set that are not contained in the other collection.
*
* @return instance of set with unmatched values removed
*/
@Nonnull
JImmutableSet intersection(@Nonnull Iterable other);
/**
* Removes all values from the Set that are not contained in the other collection.
*
* @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.
*
* @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.
*
* @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();
/**
* Returns the specified key if its contained in the set. Otherwise returns null.
*
* @param key identifies the value to retrieve
* @return the key or null
*/
@Nullable
@Override
default T get(T key)
{
return contains(key) ? key : null;
}
/**
* Returns the specified key if its contained in the set. Otherwise returns defaultValue.
*
* @param key identifies the value to retrieve
* @return the key or defaultValue
*/
@Override
default T getValueOr(T key,
T defaultValue)
{
return contains(key) ? key : defaultValue;
}
/**
* Returns a Holder containing the specified key if its contained in the set.
* Otherwise returns an empty Holder.
*
* @param key identifies the value to retrieve
* @return possibly empty Holder
*/
@Nonnull
@Override
default Holder find(T key)
{
return contains(key) ? Holders.of(key) : Holders.of();
}
/**
* Apply the transform function to all elements in iterator order and add each transformed
* value to build a new collection the same type as this.
*
* @param transform transformation applied to each element
* @return the new collection after all elements have been processed
*/
@SuppressWarnings("unchecked")
default JImmutableSet transform(@Nonnull Func1 transform)
{
return transform((JImmutableSet)deleteAll(), transform);
}
/**
* Returns a set of the same type as this containing only those elements for which
* predicate returns true. Implementations are optimized assuming predicate will
* return false more often than true.
*
* @param predicate decides whether to include an element
* @return set of same type as this containing only those elements for which predicate returns true
*/
@Nonnull
default JImmutableSet select(@Nonnull Predicate predicate)
{
JImmutableSet answer = deleteAll();
for (T value : this) {
if (predicate.test(value)) {
answer = answer.insert(value);
}
}
return answer.size() == size() ? this : answer;
}
/**
* Returns a set of the same type as this containing all those elements for which
* predicate returns false. Implementations are optimized assuming predicate will
* return false more often than true.
*
* @param predicate decides whether to include an element
* @return set of same type as this containing only those elements for which predicate returns false
*/
@Nonnull
default JImmutableSet reject(@Nonnull Predicate predicate)
{
JImmutableSet answer = this;
for (T value : this) {
if (predicate.test(value)) {
answer = answer.delete(value);
}
}
return answer.size() == size() ? this : answer;
}
/**
* Returns a Collector that creates a set of the same type as this containing all
* of the collected values inserted over whatever starting values this already contained.
*/
@Nonnull
default Collector> setCollector()
{
return GenericCollector.unordered(this, deleteAll(), a -> a.isEmpty(), (a, v) -> a.insert(v), (a, b) -> a.insertAll(b));
}
}