History (Toolsverse API Reference 5.9)

Type Parameters:

V - the value type

All Known Implementing Classes:

HistoryImpl
```
public interface History<V>
```
The history of navigation in the data structures such as List, Tree, etc. Each time element in the data structure is visited the reference is stored in the History. It is them possible to navigate back and forth by calling goBack() and goForward(). The history has a limited size. When new element increases the size to maxSize + 1 the first visited element is removed.

Since:

2.0

Version:

2.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canGoBack(V current)` Check if it is possible to go back starting from the current element.
`boolean`	`canGoForward(V current)` Check if it is possible to go forward starting from the current element.
`void`	`clear()` Clears the history
`boolean`	`contains(V element)` Checks if history contains the elements.
`List<V>`	`elements()` Gets the list of elements.
`V`	`goBack(V current)` Returns element of the history which was visited prior to current.
`V`	`goForward(V current)` Returns element of the history which was visited after the current.
`void`	`remove(V element)` Removes the element for the history.
`void`	`setMaxSize(int value)` Sets the maximum size of the history.
`int`	`size()` Returns the current size of the history.
`void`	`visit(V element)` Visits the element.

- Method Detail
  - canGoBack
```
boolean canGoBack(V current)
```
    Check if it is possible to go back starting from the current element.
    
    Parameters:
    
    current - the current element
    
    Returns:
    
    true, if successful
  - canGoForward
```
boolean canGoForward(V current)
```
    Check if it is possible to go forward starting from the current element.
    
    Parameters:
    
    current - the current element
    
    Returns:
    
    true, if successful
  - clear
```
void clear()
```
    Clears the history
  - contains
```
boolean contains(V element)
```
    Checks if history contains the elements.
    
    Parameters:
    
    element - the element to check
    
    Returns:
    
    true, if successful
  - elements
```
List<V> elements()
```
    Gets the list of elements.
    
    Returns:
    
    the list
  - goBack
```
V goBack(V current)
```
    Returns element of the history which was visited prior to current.
    
    Parameters:
    
    current - the current element
    
    Returns:
    
    the element of the history which was visited prior to current
  - goForward
```
V goForward(V current)
```
    Returns element of the history which was visited after the current.
    
    Parameters:
    
    current - the current element
    
    Returns:
    
    the element of the history which was visited after the current
  - remove
```
void remove(V element)
```
    Removes the element for the history.
    
    Parameters:
    
    element - the element
  - setMaxSize
```
void setMaxSize(int value)
```
    Sets the maximum size of the history.
    
    Parameters:
    
    value - the new max size
  - size
```
int size()
```
    Returns the current size of the history.
    
    Returns:
    
    the current size of the history
  - visit
```
void visit(V element)
```
    Visits the element.
    
    Parameters:
    
    element - the element

Interface History<V>

Method Summary

Method Detail

canGoBack

canGoForward

clear

contains

elements

goBack

goForward

remove

setMaxSize

size

visit