History (command-history-manager 1.0 API)

All Superinterfaces:

java.lang.Iterable<Command>

All Known Implementing Classes:

ComplexHistory, LinearHistory, SingleCommandHistory, SynchronizedHistoryWrapper
```
public interface History
extends java.lang.Iterable<Command>
```
Stores a history of commands based on each other.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface History.Listener
Listens to history changes.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`History.Listener` Listens to history changes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addAndExecute(Command command)` Appends the given command after the last executed one and execute it.
`void`	`addListener(History.Listener listener)` Appends a new listener to this history.
`boolean`	`contains(Command command)` Returns `true` if this list contains the specified element.
`boolean`	`executeNext()` Executes the next (most recently rolled back) command.
`Command`	`getNext()` Returns the next (most recently rolled back) command.
`Command`	`getPrevious()` Returns the previous (most recently executed) command.
`boolean`	`hasNext()` Returns `true` if there is a next (most recently rolled back) command.
`boolean`	`hasPrevious()` Returns `true` if there is a previous (most recently executed) command.
`boolean`	`isEmpty()` Returns `true` if this history contains no commands.
`java.util.Iterator<Command>`	`iterator()` Returns an iterator which iterates through the last executed path's commands.
`boolean`	`moveAfter(Command command)` Moves the internal pointer after the given command.
`boolean`	`moveBefore(Command command)` Moves the internal pointer before the given command.
`boolean`	`removeListener(History.Listener listener)` Removes a listener from this history.
`boolean`	`rollBackPrevious()` Rolls back the previous (most recently executed) command.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - iterator
```
java.util.Iterator<Command> iterator()
```
    Returns an iterator which iterates through the last executed path's commands.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Command>
    
    Returns:
    
    an iterator which iterates through the last executed path's commands
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this history contains no commands.
    
    Returns:
    
    true if this history contains no commands
  - contains
```
boolean contains(Command command)
```
    Returns true if this list contains the specified element.
    
    Parameters:
    
    command - the command whose presence in this list is to be tested
    
    Returns:
    
    true if this history contains the specified command
  - addAndExecute
```
boolean addAndExecute(Command command)
```
    Appends the given command after the last executed one and execute it.
    
    Returns:
    
    true if the command successfully executed and inserted
  - hasNext
```
boolean hasNext()
```
    Returns true if there is a next (most recently rolled back) command.
    
    Returns:
    
    true if there is a next command
  - getNext
```
Command getNext()
```
    Returns the next (most recently rolled back) command.
    
    Returns:
    
    the next command if any or null
  - executeNext
```
boolean executeNext()
```
    Executes the next (most recently rolled back) command.
    
    Returns:
    
    true if a next command is successfully executed
  - hasPrevious
```
boolean hasPrevious()
```
    Returns true if there is a previous (most recently executed) command.
    
    Returns:
    
    true if there is a previous command
  - getPrevious
```
Command getPrevious()
```
    Returns the previous (most recently executed) command.
    
    Returns:
    
    the previous command if any or null
  - rollBackPrevious
```
boolean rollBackPrevious()
```
    Rolls back the previous (most recently executed) command.
    
    Returns:
    
    true if a previous command is successfully rolled back
  - moveBefore
```
boolean moveBefore(Command command)
```
    Moves the internal pointer before the given command. Commands in the shortest route between current and given command will be executed or rolled back.
    
    Returns:
    
    true if the command found and pointer successfully moved
  - moveAfter
```
boolean moveAfter(Command command)
```
    Moves the internal pointer after the given command. Commands in the shortest route between current and given command will be executed or rolled back.
    
    Returns:
    
    true if the command found and pointer successfully moved
  - addListener
```
void addListener(History.Listener listener)
```
    Appends a new listener to this history.
    
    Parameters:
    
    listener - the new listener
  - removeListener
```
boolean removeListener(History.Listener listener)
```
    Removes a listener from this history.
    
    Returns:
    
    true if the listener found and removed

Interface History

Nested Class Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

isEmpty

contains

addAndExecute

hasNext

getNext

executeNext

hasPrevious

getPrevious

rollBackPrevious

moveBefore

moveAfter

addListener

removeListener