com.jongsoft.lang.collection.List Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright 2016-2019 Jong Soft.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.jongsoft.lang.collection;
import com.jongsoft.lang.collection.support.Collections;
import java.util.Comparator;
import java.util.Objects;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
/**
*
* @param the entity type of the sequence
* @since 0.0.5
*/
public interface List extends Collection {
/**
* Create a new list containing all elements in this instance and appending the provided {@code value} to the end of the new list.
*
* Example:
* {@code // will result in a list with 2, 3, 4, 1
* List(2, 3, 4).append(1)
* }
*
* @param value the value to append to the list
* @return the new list with the value appended
*/
List append(T value);
/**
* Creates a distinct list based upon the provided comparator. If a duplicate is found only the first match will
* be included in the returned list.
*
* @since 1.1.0
* @param comparator the comparator to use for distinct check
* @return the distinct list
*/
List distinctBy(Comparator comparator);
/**
* Search the collections for the first element matching the provided {@link Predicate} and return the index
* position of that element.
*
* @param predicate the predicate to match
* @return index of the found element, -1 if none found
*/
int firstIndexWhere(Predicate predicate);
@Override
List filter(Predicate predicate);
/**
* Get the element at the location of index
*
* @param index the index of the element in the list to get
* @return the element at the provided index
* @throws IndexOutOfBoundsException if {@code index} is greater then the {@link #size()} - 1
*/
T get(int index);
/**
* Generate a new sequence using the {@code keyGenerator}.
* Calling this operation will create a new map grouping the elements by the generator provided.
* Example:
* {@code // This will result in Map(1 -> List(1, 11, 21), 2 -> List(2, 12, 22))
* Sequence(1, 2, 11, 12, 21, 22)
* .groupBy(x -> x % 10);
* }
*
* @param keyGenerator the generator to use for creating keys
* @param the type of the key
* @return the new map created using the generator
* @throws NullPointerException if {@code keyGenerator} is null
*/
Map> groupBy(Function keyGenerator);
/**
* Find the index for the provided element, will return -1 if the element
* is not present in the list.
*
* @param lookFor the element to look for
* @return the index of the element, or -1 if none found
*/
default int indexOf(Object lookFor) {
return firstIndexWhere(e -> Objects.equals(lookFor, e));
}
@Override
List map(Function mapper);
/**
* Computes the median value of the set. This will only work if all elements in the set are of the
* type {@link Number}.
*
* @since 1.1.2
* @return The median value.
*/
default double median() {
return Collections.median(this, t -> ((Number) t).doubleValue());
}
@Override
List orElse(Iterable other);
@Override
List orElse(Supplier> supplier);
/**
* Create a pipeline for the current list. A pipeline can be used to create a set of lazy operations on the list
* that will only get executed once the pipe is terminated.
*
* @return the pipeline for this list
*/
Pipeline pipeline();
@Override
List reject(Predicate predicate);
/**
* Removes an element from the list and returns a new instance of the list.
*
* @param index the index of the element to be removed
* @return the new instance of the list without the element at the provided index
* @throws IndexOutOfBoundsException if {@code index} is not between the 0 and {@linkplain #size()}
*/
List remove(int index);
/**
* Replaces the element at index index with the provided replacement element.
*
* @param index the index of the element to be replaced in this list
* @param replacement the replacement to put in its place
* @return the updated list
* @throws IndexOutOfBoundsException if {@code index} is not between the 0 and {@linkplain #size()}
*/
List replace(int index, T replacement);
/**
* Replace any element in the list that matches using the provided {@code predicate} with the provided new
* element.
*
* @param predicate the predicate to validate existing elements with
* @param replacement the replacement when the predicate returns true
* @return the updated list
*/
List replaceIf(Predicate predicate, T replacement);
/**
* Sorts the specified array of objects into ascending order, according to the natural ordering of its elements. All elements
* in the array must implement the Comparable interface. Furthermore, all elements in the array must be mutually comparable
* (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the array).
*
* This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.
* Implementation note: This implementation is a stable, adaptive, iterative mergesort that requires far fewer than n lg(n)
* comparisons when the input array is partially sorted, while offering the performance of a traditional mergesort when the
* input array is randomly ordered. If the input array is nearly sorted, the implementation requires approximately n comparisons.
* Temporary storage requirements vary from a small constant for nearly sorted input arrays to n/2 object references
* for randomly ordered input arrays.
*
* The implementation takes equal advantage of ascending and descending order in its input array, and can take advantage
* of ascending and descending order in different parts of the same input array. It is well-suited to merging two or
* more sorted arrays: simply concatenate the arrays and sort the resulting array.
*
* @since 1.1.2
* @return the sorted set
*/
List sorted();
@Override
List tail();
/**
* Create a new sequence with all elements of this sequence combined with the elements of the provided iterable.
* The elements in this sequence will be added before the provided {@code iterable} in the returned sequence.
*
* Example:
* {@code // the example would be a List(1, 2, 3, 4)
* List result = List(1, 2).union(List(3, 4));
* }
*
* @param iterable the elements to be added
* @return the new list containing a union between this and the iterable
*/
List union(Iterable iterable);
}