org.javimmutable.collections.list.AbstractNode Maven / Gradle / Ivy

Go to download
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2023, 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.list;

import org.javimmutable.collections.Func0;
import org.javimmutable.collections.Func1;
import org.javimmutable.collections.InvariantCheckable;
import org.javimmutable.collections.SplitableIterable;
import org.javimmutable.collections.common.CollisionMap;
import org.javimmutable.collections.common.CollisionSet;
import org.javimmutable.collections.iterators.GenericIterator;

import javax.annotation.Nonnull;

abstract class AbstractNode
    implements SplitableIterable,
               InvariantCheckable,
               GenericIterator.Iterable,
               CollisionMap.Node,
               CollisionSet.Node
{
    abstract boolean isEmpty();

    abstract int size();

    abstract int depth();

    abstract T get(int index);

    abstract  C seekImpl(int index,
                            Func0 defaultMapping,
                            Func1 valueMapping);

    @Nonnull
    abstract AbstractNode append(T value);

    @Nonnull
    abstract AbstractNode append(@Nonnull AbstractNode node);

    @Nonnull
    abstract AbstractNode prepend(T value);

    @Nonnull
    abstract AbstractNode prepend(@Nonnull AbstractNode node);

    @Nonnull
    abstract AbstractNode assign(int index,
                                    T value);

    @Nonnull
    abstract AbstractNode insert(int index,
                                    T value);

    @Nonnull
    abstract AbstractNode deleteFirst();

    @Nonnull
    abstract AbstractNode deleteLast();

    @Nonnull
    abstract AbstractNode delete(int index);

    @Nonnull
    abstract AbstractNode prefix(int limit);

    @Nonnull
    abstract AbstractNode suffix(int offset);

    @Nonnull
    abstract AbstractNode reverse();

    abstract void copyTo(T[] array,
                         int offset);

    @Nonnull
    AbstractNode left()
    {
        throw new UnsupportedOperationException();
    }

    @Nonnull
    AbstractNode right()
    {
        throw new UnsupportedOperationException();
    }

    @Override
    public int iterableSize()
    {
        return size();
    }
}