org.javimmutable.collections.JImmutableRandomAccessList Maven / Gradle / Ivy
///###////////////////////////////////////////////////////////////////////////
//
// Burton Computer Corporation
// http://www.burton-computer.com
//
// Copyright (c) 2017, 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.function.Predicate;
/**
* Extension of JImmutableList that allows insertion and deletion at arbitrary
* indexes within the list.
*/
@Immutable
public interface JImmutableRandomAccessList
extends JImmutableList
{
interface Builder
extends MutableBuilder>
{
}
/**
* Replaces the value at the specified index (which must be within current
* bounds of the list) with the new value.
*
* @throws IndexOutOfBoundsException if index is out of bounds
*/
@Nonnull
JImmutableRandomAccessList assign(int index,
@Nullable T value);
/**
* Adds a value to the end of the list. May be invoked on an empty list.
*/
@Nonnull
JImmutableRandomAccessList insert(@Nullable T value);
/**
* Insert value at index (which must be within 0 to size).
* Shifts all values at and after index one position to the right and adds 1
* to size of the list.
*/
@Nonnull
JImmutableRandomAccessList insert(int index,
@Nullable T value);
/**
* Adds a value to the front of the list. May be invoked on an empty list.
* Synonym for insert()
*/
@Nonnull
JImmutableRandomAccessList insertFirst(@Nullable T value);
/**
* Adds a value to the end of the list. May be invoked on an empty list.
* Synonym for insert().
*/
@Nonnull
JImmutableRandomAccessList insertLast(@Nullable T value);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAllLast()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(@Nonnull Cursorable values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAllLast()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(@Nonnull Collection values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAllLast()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(@Nonnull Cursor values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAllLast()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(@Nonnull Iterator values);
/**
* Inserts all elements at index (which must be within 0 to size) in the same
* order they appear in the Iterable.
* Shifts all values at and after index x positions to the right and adds x
* to size of the list, where x is the number of elements being inserted.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(int index,
@Nonnull Cursorable values);
/**
* Inserts all elements at index (which must be within 0 to size) in the same
* order they appear in the Iterable.
* Shifts all values at and after index x positions to the right and adds x
* to size of the list, where x is the number of elements being inserted.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(int index,
@Nonnull Collection values);
/**
* Inserts all elements at index (which must be within 0 to size) in the same
* order they appear in the Iterable.
* Shifts all values at and after index x positions to the right and adds x
* to size of the list, where x is the number of elements being inserted.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(int index,
@Nonnull Cursor values);
/**
* Inserts all elements at index (which must be within 0 to size) in the same
* order they appear in the Iterable.
* Shifts all values at and after index x positions to the right and adds x
* to size of the list, where x is the number of elements being inserted.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAll(int index,
@Nonnull Iterator values);
/**
* Adds the values to the beginning of the list in the same order they appear in the Iterable. May be invoked on an empty list.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllFirst(@Nonnull Cursorable values);
/**
* Adds the values to the beginning of the list in the same order they appear in the Iterable. May be invoked on an empty list.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllFirst(@Nonnull Collection values);
/**
* Adds the values to the beginning of the list in the same order they appear in the Iterable. May be invoked on an empty list.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllFirst(@Nonnull Cursor values);
/**
* Adds the values to the beginning of the list in the same order they appear in the Iterable. May be invoked on an empty list.
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllFirst(@Nonnull Iterator values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAll()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllLast(@Nonnull Cursorable values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAll()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllLast(@Nonnull Collection values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAll()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllLast(@Nonnull Cursor values);
/**
* Adds the values to the end of the list in the same order they appear in the Iterable. May be invoked on an empty list.
* Synonym for insertAll()
*
* @return instance of list containing the collection
*/
@Nonnull
JImmutableRandomAccessList insertAllLast(@Nonnull Iterator values);
/**
* Removes the first value from the list and reduces size by 1. size() must be greater than zero
*
* @return new JImmutableList without last value
* @throws IndexOutOfBoundsException if list is already empty
*/
@Nonnull
JImmutableRandomAccessList deleteFirst();
/**
* Removes the last value from the list and reduces size by 1. size() must be greater than zero
*
* @return new JImmutableList without last value
* @throws IndexOutOfBoundsException if list is already empty
*/
@Nonnull
JImmutableRandomAccessList deleteLast();
/**
* Delete value at index (which must be within the current bounds of the list).
* Shifts all values at and after index one position to the left and subtracts 1
* from size of the list.
*/
@Nonnull
JImmutableRandomAccessList delete(int index);
/**
* @return an equivalent collection with no values
*/
@Nonnull
JImmutableRandomAccessList deleteAll();
/**
* Returns a list of the same type as this containing all those elements for which
* predicate returns false. Implementation optimized assuming predicate will
* return false more often than true.
*
* @param predicate decides whether to include an element
* @return list of same type as this containing only those elements for which predicate returns false
*/
@Nonnull
@Override
default JImmutableRandomAccessList reject(@Nonnull Predicate predicate)
{
JImmutableRandomAccessList answer = this;
int index = 0;
for (T value : this) {
assert value == answer.get(index);
if (predicate.test(value)) {
answer = answer.delete(index);
} else {
index += 1;
}
}
return answer.size() == size() ? this : answer;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy