org.javimmutable.collections.array.JImmutableTrieArray 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.array;
import org.javimmutable.collections.Holder;
import org.javimmutable.collections.Holders;
import org.javimmutable.collections.Indexed;
import org.javimmutable.collections.IterableStreamable;
import org.javimmutable.collections.JImmutableArray;
import org.javimmutable.collections.JImmutableMap;
import org.javimmutable.collections.MapEntry;
import org.javimmutable.collections.SplitableIterator;
import org.javimmutable.collections.common.ArrayToMapAdaptor;
import org.javimmutable.collections.common.StreamConstants;
import org.javimmutable.collections.iterators.GenericIterator;
import org.javimmutable.collections.iterators.IteratorHelper;
import org.javimmutable.collections.iterators.TransformIterator;
import org.javimmutable.collections.iterators.TransformStreamable;
import org.javimmutable.collections.serialization.JImmutableArrayProxy;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;
import java.util.stream.Collector;
@Immutable
public class JImmutableTrieArray
implements Serializable,
JImmutableArray
{
@SuppressWarnings("unchecked")
private static final JImmutableTrieArray EMPTY = new JImmutableTrieArray(TrieNode.of());
private static final long serialVersionUID = -121805;
private final TrieNode root;
private JImmutableTrieArray(TrieNode root)
{
this.root = root;
}
public static Builder builder()
{
return new Builder<>();
}
@Nonnull
public static Collector> collector()
{
return Collector., JImmutableArray>of(() -> new Builder<>(),
(b, v) -> b.add(v),
(b1, b2) -> (Builder)b1.add(b2.iterator()),
b -> b.build());
}
@SuppressWarnings("unchecked")
public static JImmutableTrieArray of()
{
return EMPTY;
}
/**
* Efficiently constructs a TrieArray containing the objects from source (in the specified range).
* In the constructed TrieArray objects will have array indexes starting at 0 (i.e. indexes
* from the source are not carried over) so if offset is 10 then source.get(10) will map to
* array.get(0).
*
* @deprecated use builder() instead
*/
@Deprecated
public static JImmutableArray of(Indexed source,
int offset,
int limit)
{
return JImmutableTrieArray.builder().add(source, offset, limit).build();
}
@Override
@Nullable
public T get(int index)
{
return find(index).getValueOrNull();
}
@Override
@Nullable
public T getValueOr(int index,
@Nullable T defaultValue)
{
if (root.getShift() < TrieNode.shiftForIndex(index)) {
return defaultValue;
} else {
return root.getValueOr(root.getShift(), index, defaultValue);
}
}
@Nonnull
@Override
public Holder find(int index)
{
if (root.getShift() < TrieNode.shiftForIndex(index)) {
return Holders.of();
} else {
return root.find(root.getShift(), index);
}
}
@Nonnull
@Override
public Holder> findEntry(int key)
{
Holder value = find(key);
return value.isFilled() ? Holders.of(MapEntry.of(key, value.getValue())) : Holders.of();
}
@Nonnull
@Override
public JImmutableTrieArray assign(int index,
@Nullable T value)
{
TrieNode newRoot = root.paddedToMinimumDepthForShift(TrieNode.shiftForIndex(index));
newRoot = newRoot.assign(newRoot.getShift(), index, value);
return (newRoot == root) ? this : new JImmutableTrieArray<>(newRoot);
}
/**
* Adds the key/value pair to this map. Any value already existing for the specified key
* is replaced with the new value.
*/
@Override
@Nonnull
public JImmutableArray insert(@Nullable JImmutableMap.Entry e)
{
return (e == null) ? this : assign(e.getKey(), e.getValue());
}
@Nonnull
@Override
public JImmutableTrieArray delete(int index)
{
if (root.getShift() < TrieNode.shiftForIndex(index)) {
return this;
} else {
final TrieNode newRoot = root.delete(root.getShift(), index).trimmedToMinimumDepth();
return (newRoot == root) ? this : new JImmutableTrieArray<>(newRoot);
}
}
@Override
public boolean isEmpty()
{
return root.isEmpty();
}
@Override
public int size()
{
return root.valueCount();
}
@Nonnull
@Override
public JImmutableTrieArray deleteAll()
{
return of();
}
@Nonnull
@Override
public JImmutableArray getInsertableSelf()
{
return this;
}
@Nonnull
@Override
public IterableStreamable keys()
{
return TransformStreamable.ofKeys(this);
}
@Nonnull
@Override
public IterableStreamable values()
{
return TransformStreamable.ofValues(this);
}
@Override
public int getSpliteratorCharacteristics()
{
return StreamConstants.SPLITERATOR_ORDERED;
}
@Nonnull
@Override
public SplitableIterator> iterator()
{
return new GenericIterator<>(root, 0, root.valueCount());
}
@Nonnull
@Override
public Map getMap()
{
return ArrayToMapAdaptor.of(this);
}
@Override
public void checkInvariants()
{
root.checkInvariants();
}
@Override
public boolean equals(Object o)
{
return (o == this) || ((o instanceof JImmutableArray) && IteratorHelper.iteratorEquals(iterator(), ((JImmutableArray)o).iterator()));
}
@Override
public int hashCode()
{
return IteratorHelper.iteratorHashCode(iterator());
}
@Override
public String toString()
{
return IteratorHelper.iteratorToString(iterator());
}
private Object writeReplace()
{
return new JImmutableArrayProxy(this);
}
public static class Builder
implements JImmutableArray.Builder
{
private final TrieArrayBuilder builder;
private Builder()
{
builder = new TrieArrayBuilder<>();
}
@Override
public int size()
{
return builder.size();
}
@Nonnull
@Override
public JImmutableArray.Builder clear()
{
builder.clear();
return this;
}
@Nonnull
@Override
public Builder add(T value)
{
builder.add(value);
return this;
}
@Nonnull
@Override
public JImmutableTrieArray build()
{
return builder.size() == 0 ? of() : new JImmutableTrieArray<>(builder.build());
}
@Nonnull
private Iterator iterator()
{
return TransformIterator.of(builder.build().iterator(), e -> e.getValue());
}
}
}