HistoricalList.java

package org.opentrafficsim.core.perception.collections;

import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Objects;
import java.util.function.UnaryOperator;

import org.djunits.value.vdouble.scalar.Time;

/**
 * Interface for historical lists.
 * <p>
 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
 * </p>
 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
 * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
 * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
 * @param <E> element type
 */
public interface HistoricalList<E> extends HistoricalCollection<E>, List<E>
{

    /**
     * Returns the current list.
     * @return current list
     */
    @Override
    List<E> get();

    /**
     * Returns a past list.
     * @param time time to obtain the list at
     * @return past list
     */
    @Override
    List<E> get(Time time);

    @Override
    default void replaceAll(final UnaryOperator<E> operator)
    {
        // super uses ListIterator.set(E), which is not supported
        Objects.requireNonNull(operator);
        for (int i = 0; i < size(); i++)
        {
            set(i, operator.apply(get(i)));
        }
    }

    @SuppressWarnings({"rawtypes", "unchecked"})
    @Override
    default void sort(final Comparator<? super E> c)
    {
        // super uses ListIterator.set(E), which is not supported
        Object[] a = this.toArray();
        Arrays.sort(a, (Comparator) c);
        for (int i = 0; i < a.length; i++)
        {
            set(i, (E) a[i]);
        }
    }

}