public class

ItemHistory

extends Object
java.lang.Object
   ↳ com.pnfsoftware.jeb.util.collect.ItemHistory<T>

Class Overview

Generic tracker of items, based on a simple history queue (get last, get next) model.

Typically, such objects are long-lived; internally, references to items are strong. Therefore, it is up to the user to make sure that referenced objects are not prevented from being garbage collected, should they be.

Summary

Public Constructors
ItemHistory()
Create a history of 1 with a capacity of 100 and cleanHistoryAfterIndex set to true.
ItemHistory(int capacity, boolean cleanHistoryAfterIndex)
Create a history object with the
Public Methods
void add(T item)
void addAll(Collection<T> items)
void capacity(int capacity)
Update the history capacity.
int capacity()
Get the history maximum capacity.
List<T> get()
Retrieve a copy of the history items.
T getMostRecent()
T getNext(T updatedItem)
T getNext()
T getPrevious(T updatedItem)
T getPrevious()
boolean hasNext()
boolean hasPrevious()
int position()
Get the current history index.
boolean remove(T item)
void reset()
int size()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ItemHistory ()

Create a history of 1 with a capacity of 100 and cleanHistoryAfterIndex set to true.

public ItemHistory (int capacity, boolean cleanHistoryAfterIndex)

Create a history object with the

Parameters
capacity maximum capacity, must be at least 1
cleanHistoryAfterIndex if true, recording an element into the history when the history index is not at the top will erase all elements after the index and add the new item at the top; if false, the item is inserted at the top regardless of where the history index was

Public Methods

public void add (T item)

public void addAll (Collection<T> items)

public void capacity (int capacity)

Update the history capacity.

public int capacity ()

Get the history maximum capacity.

public List<T> get ()

Retrieve a copy of the history items. The first item in the returned list is the oldest one.

public T getMostRecent ()

public T getNext (T updatedItem)

public T getNext ()

public T getPrevious (T updatedItem)

public T getPrevious ()

public boolean hasNext ()

public boolean hasPrevious ()

public int position ()

Get the current history index. Navigating the history using getNext(), getPrevious(), or modifying the history using add(),remove(), etc. updates this pointer.

public boolean remove (T item)

public void reset ()

public int size ()

public String toString ()