Package org.opentrafficsim.core.perception.collections

Class HistoricalLinkedList<E>

java.lang.Object

org.opentrafficsim.core.perception.AbstractHistorical<E,AbstractHistoricalCollection.EventCollection<E,C>>

org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection<E,L>

org.opentrafficsim.core.perception.collections.AbstractHistoricalList<E,LinkedList<E>>

org.opentrafficsim.core.perception.collections.HistoricalLinkedList<E>

Type Parameters:

E - element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>, HistoricalCollection<E>, HistoricalDeque<E>, HistoricalList<E>, HistoricalQueue<E>, HistoryManager.HistoricalElement

public class HistoricalLinkedList<E>
extends AbstractHistoricalList<E,LinkedList<E>>
implements HistoricalDeque<E>

LinkedList-valued historical state. The current linked list is always maintained, and past states of the linked list are obtained by applying the events between now and the requested time in reverse.

The Iterator returned by this class does not support the remove(), add() and set() methods. Any returned sublist is unmodifiable.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 3 feb. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalList

AbstractHistoricalList.AddEvent<E,L extends List<E>>, AbstractHistoricalList.EventList<E,L extends List<E>>, AbstractHistoricalList.RemoveEvent<E,L extends List<E>>

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection

AbstractHistoricalCollection.EventCollection<E,C extends Collection<E>>

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical

AbstractHistorical.EventValue<T>

Constructor Summary

Constructors

Constructor	Description
HistoricalLinkedList(HistoryManager historyManager)	Construct a new, empty HistoricalLinkedList.
HistoricalLinkedList(HistoryManager historyManager, Collection<? extends E> c)	Construct a new HistoricalLinkedList and add all elements of the given collection to it.

Method Summary

Modifier and Type	Method	Description
void	addFirst(E e)
void	addLast(E e)
Iterator<E>	descendingIterator()	This implementation copies a list and reverses the order before returning the iterator.
E	element()
LinkedList<E>	get()	Retrieve the current, internal deque.
LinkedList<E>	get(Time time)	Retrieve a past deque.
E	getFirst()
E	getLast()
boolean	offer(E e)
boolean	offerFirst(E e)
boolean	offerLast(E e)
E	peek()
E	peekFirst()
E	peekLast()
E	poll()
E	pollFirst()
E	pollLast()
E	pop()
void	push(E e)
E	remove()
E	removeFirst()
boolean	removeFirstOccurrence(Object o)
E	removeLast()
boolean	removeLastOccurrence(Object o)
String	toString()

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalList

add, add, addAll, get, indexOf, lastIndexOf, listIterator, listIterator, remove, remove, set, subList

Methods inherited from class org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection

addAll, clear, contains, containsAll, fill, fill, getCollection, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from class org.opentrafficsim.core.perception.AbstractHistorical

addEvent, cleanUpHistory, getEvent, getEvents, getLastEvent, isLastState, now, removeEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.Deque

add, addAll, contains, iterator, remove, size

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalCollection

removeIf

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalList

replaceAll, sort

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, spliterator, toArray, toArray

Constructor Detail

HistoricalLinkedList

public HistoricalLinkedList(HistoryManager historyManager)

Construct a new, empty HistoricalLinkedList.

Parameters:

historyManager - HistoryManager; history manager

HistoricalLinkedList

public HistoricalLinkedList(HistoryManager historyManager,
                            Collection<? extends E> c)

Construct a new HistoricalLinkedList and add all elements of the given collection to it.

Parameters:

historyManager - HistoryManager; history manager

c - Collection<? extends E>; initial collection

Method Detail

get

public LinkedList<E> get()

Retrieve the current, internal deque. TODO document if the result may be modified.

Specified by:

get in interface HistoricalCollection<E>

Specified by:

get in interface HistoricalDeque<E>

Specified by:

get in interface HistoricalList<E>

Specified by:

get in interface HistoricalQueue<E>

Returns:

Deque<E>; the current, internal deque

get

public LinkedList<E> get(Time time)

Retrieve a past deque.

Specified by:

get in interface HistoricalCollection<E>

Specified by:

get in interface HistoricalDeque<E>

Specified by:

get in interface HistoricalList<E>

Specified by:

get in interface HistoricalQueue<E>

Parameters:

time - Time; time to obtain the deque at

Returns:

Deque<E>; past deque

toString

public String toString()

Overrides:

toString in class Object

offer

public boolean offer(E e)

Specified by:

offer in interface Deque<E>

Specified by:

offer in interface Queue<E>

offerLast

public boolean offerLast(E e)

Specified by:

offerLast in interface Deque<E>

addLast

public void addLast(E e)

Specified by:

addLast in interface Deque<E>

remove

public E remove()

Specified by:

remove in interface Deque<E>

Specified by:

remove in interface Queue<E>

removeFirst

public E removeFirst()

Specified by:

removeFirst in interface Deque<E>

pop

public E pop()

Specified by:

pop in interface Deque<E>

pollFirst

public E pollFirst()

Specified by:

pollFirst in interface Deque<E>

poll

public E poll()

Specified by:

poll in interface Deque<E>

Specified by:

poll in interface Queue<E>

addFirst

public void addFirst(E e)

Specified by:

addFirst in interface Deque<E>

push

public void push(E e)

Specified by:

push in interface Deque<E>

offerFirst

public boolean offerFirst(E e)

Specified by:

offerFirst in interface Deque<E>

removeLast

public E removeLast()

Specified by:

removeLast in interface Deque<E>

pollLast

public E pollLast()

Specified by:

pollLast in interface Deque<E>

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

Specified by:

removeFirstOccurrence in interface Deque<E>

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

Specified by:

removeLastOccurrence in interface Deque<E>

element

public E element()

Specified by:

element in interface Deque<E>

Specified by:

element in interface Queue<E>

peek

public E peek()

Specified by:

peek in interface Deque<E>

Specified by:

peek in interface Queue<E>

getFirst

public E getFirst()

Specified by:

getFirst in interface Deque<E>

getLast

public E getLast()

Specified by:

getLast in interface Deque<E>

peekFirst

public E peekFirst()

Specified by:

peekFirst in interface Deque<E>

peekLast

public E peekLast()

Specified by:

peekLast in interface Deque<E>

descendingIterator

public Iterator<E> descendingIterator()

This implementation copies a list and reverses the order before returning the iterator. This is not efficient and it should be avoided when possible.

Specified by:

descendingIterator in interface Deque<E>