Autopsy  4.14.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.coreutils.History< T > Class Template Reference

Classes

class  ObservableStack
 

Public Member Functions

 History (T initialState)
 
 History ()
 
synchronized T advance ()
 
synchronized void advance (T newState) throws IllegalArgumentException
 
synchronized boolean canAdvance ()
 
synchronized boolean canRetreat ()
 
synchronized void clear ()
 
synchronized ReadOnlyObjectProperty< T > currentState ()
 
synchronized ReadOnlyBooleanProperty getCanAdvance ()
 
synchronized ReadOnlyBooleanProperty getCanRetreat ()
 
synchronized T getCurrentState ()
 
synchronized void reset (T newState)
 
synchronized T retreat ()
 

Private Attributes

final ReadOnlyBooleanWrapper canAdvance = new ReadOnlyBooleanWrapper()
 
final ReadOnlyBooleanWrapper canRetreat = new ReadOnlyBooleanWrapper()
 
final ReadOnlyObjectWrapper< T > currentState = new ReadOnlyObjectWrapper<>()
 
final ObservableStack< T > forwardStack = new ObservableStack<>()
 
final ObservableStack< T > historyStack = new ObservableStack<>()
 

Detailed Description

A basic history implementation. Keeps a history (and forward) stack of state objects of type T. exposes current state and availability of advance/retreat operations via methods and JFX Property objects. Null is not a valid state, and will only be the current state before the first call to advance.

Parameters
Tthe type of objects used to represent the current/historical/future states

Definition at line 42 of file History.java.

Constructor & Destructor Documentation

Definition at line 88 of file History.java.

Definition at line 93 of file History.java.

Member Function Documentation

synchronized T org.sleuthkit.autopsy.coreutils.History< T >.advance ( )

advance through the forward states by one, and put the current state in the history. Is a no-op if there are no forward states.

Returns
the state advanced to, or null if there were no forward states.

Definition at line 110 of file History.java.

synchronized void org.sleuthkit.autopsy.coreutils.History< T >.advance ( newState) throws IllegalArgumentException

put the current state in the history and advance to the given state. It is a no-op if the current state is equal to the given state as determined by invoking the equals method. Throws away any forward states.

Parameters
newStatethe new state to advance to
Exceptions
IllegalArgumentExceptionif newState == null

Definition at line 149 of file History.java.

synchronized boolean org.sleuthkit.autopsy.coreutils.History< T >.canAdvance ( )
synchronized boolean org.sleuthkit.autopsy.coreutils.History< T >.canRetreat ( )
synchronized void org.sleuthkit.autopsy.coreutils.History< T >.clear ( )

Definition at line 163 of file History.java.

synchronized ReadOnlyObjectProperty<T> org.sleuthkit.autopsy.coreutils.History< T >.currentState ( )
synchronized ReadOnlyBooleanProperty org.sleuthkit.autopsy.coreutils.History< T >.getCanAdvance ( )

Definition at line 80 of file History.java.

synchronized ReadOnlyBooleanProperty org.sleuthkit.autopsy.coreutils.History< T >.getCanRetreat ( )

Definition at line 84 of file History.java.

synchronized T org.sleuthkit.autopsy.coreutils.History< T >.getCurrentState ( )

Definition at line 64 of file History.java.

synchronized void org.sleuthkit.autopsy.coreutils.History< T >.reset ( newState)

Definition at line 98 of file History.java.

synchronized T org.sleuthkit.autopsy.coreutils.History< T >.retreat ( )

retreat through the history states by one, and add the current state to the forward states. Is a no-op if there are no history states.

Returns
the state retreated to, or null if there were no history states.

Definition at line 127 of file History.java.

Referenced by org.sleuthkit.autopsy.coreutils.History< org.sleuthkit.autopsy.timeline.zooming.EventsModelParams >.retreat().

Member Data Documentation

final ReadOnlyBooleanWrapper org.sleuthkit.autopsy.coreutils.History< T >.canAdvance = new ReadOnlyBooleanWrapper()
private

Definition at line 58 of file History.java.

final ReadOnlyBooleanWrapper org.sleuthkit.autopsy.coreutils.History< T >.canRetreat = new ReadOnlyBooleanWrapper()
private

Definition at line 62 of file History.java.

final ReadOnlyObjectWrapper<T> org.sleuthkit.autopsy.coreutils.History< T >.currentState = new ReadOnlyObjectWrapper<>()
private

Definition at line 54 of file History.java.

final ObservableStack<T> org.sleuthkit.autopsy.coreutils.History< T >.forwardStack = new ObservableStack<>()
private
final ObservableStack<T> org.sleuthkit.autopsy.coreutils.History< T >.historyStack = new ObservableStack<>()
private

The documentation for this class was generated from the following file:

Copyright © 2012-2020 Basis Technology. Generated on: Wed Apr 8 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.