/*
 * Copyright (c) 2018 Goldman Sachs and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v. 1.0 which accompany this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 */

package org.eclipse.collections.api.list.primitive;

import org.eclipse.collections.api.CharIterable;
import org.eclipse.collections.api.block.function.primitive.CharIntToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.CharToObjectFunction;
import org.eclipse.collections.api.block.predicate.primitive.CharPredicate;
import org.eclipse.collections.api.block.procedure.primitive.CharProcedure;
import org.eclipse.collections.api.list.ListIterable;
import org.eclipse.collections.api.ordered.primitive.ReversibleCharIterable;
import org.eclipse.collections.api.tuple.primitive.CharCharPair;
import org.eclipse.collections.api.tuple.primitive.CharObjectPair;

This file was automatically generated from template file primitiveList.stg.
Since:
3.0./**
 * This file was automatically generated from template file primitiveList.stg.
 *
 * @since 3.0.
 */
public interface CharList extends ReversibleCharIterable
{
    char get(int index);

    long dotProduct(CharList list);

    int binarySearch(char value);

    int lastIndexOf(char value);

    @Override
    CharList select(CharPredicate predicate);

    @Override
    CharList reject(CharPredicate predicate);

    
Since:
9.0./**
     * @since 9.0.
     */
    @Override
    default CharList tap(CharProcedure procedure)
    {
        this.forEach(procedure);
        return this;
    }

    @Override
    <V> ListIterable<V> collect(CharToObjectFunction<? extends V> function);

    
Returns a new ListIterable using results obtained by applying the specified function to each element
and its corresponding index.
Since:
9.1./**
     * Returns a new ListIterable using results obtained by applying the specified function to each element
     * and its corresponding index.
     *
     * @since 9.1.
     */
    @Override
    default <V> ListIterable<V> collectWithIndex(CharIntToObjectFunction<? extends V> function)
    {
        int[] index = { 0 };
        return this.collect(each -> function.value(each, index[0]++));
    }

    
Follows the same general contract as List.equals(Object). /**
     * Follows the same general contract as {@link java.util.List#equals(Object)}.
     */
    @Override
    boolean equals(Object o);

    
Follows the same general contract as List.hashCode(). /**
     * Follows the same general contract as {@link java.util.List#hashCode()}.
     */
    @Override
    int hashCode();

    
Returns an immutable copy of this list. If the list is immutable, it returns itself.
/**
     * Returns an immutable copy of this list. If the list is immutable, it returns itself.
     */
    ImmutableCharList toImmutable();

    
Since:
6.0./**
     * @since 6.0.
     */
    @Override
    CharList distinct();

    
Since:
5.0./**
     * @since 5.0.
     */
    @Override
    CharList toReversed();

    
See Also:
subList.subList(int fromIndex, int toIndex)
Since:
5.0./**
     * @see java.util.List#subList(int fromIndex, int toIndex)
     * @since 5.0.
     */
    CharList subList(int fromIndex, int toIndex);

    
Returns a ListIterable formed from this CharList and another CharList by combining corresponding elements in pairs. If one of the two CharLists is longer than the other, its remaining elements are ignored. 
Since:
9.1./**
     * Returns a {@code ListIterable} formed from this {@code CharList} and another {@code CharList} by
     * combining corresponding elements in pairs. If one of the two {@code CharList}s is longer than the other, its
     * remaining elements are ignored.
     *
     * @since 9.1.
     */
    default ListIterable<CharCharPair> zipChar(CharIterable iterable)
    {
        throw new UnsupportedOperationException("Default method to prevent breaking backwards compatibility");
    }

    
Returns a ListIterable formed from this CharList and a ListIterable by combining corresponding elements in pairs. If one of the two Lists is longer than the other, its remaining elements are ignored. 
Since:
9.1./**
     * Returns a {@code ListIterable} formed from this {@code CharList} and a {@code ListIterable} by
     * combining corresponding elements in pairs. If one of the two Lists is longer than the other, its
     * remaining elements are ignored.
     *
     * @since 9.1.
     */
    default <T> ListIterable<CharObjectPair<T>> zip(Iterable<T> iterable)
    {
        throw new UnsupportedOperationException("Default method to prevent breaking backwards compatibility");
    }
}