Module com.dlsc.gemsfx

Package com.dlsc.gemsfx.util

Class HistoryManager<T>

java.lang.Object

com.dlsc.gemsfx.util.HistoryManager<T>

Type Parameters:

T - the type of items stored in the history

Direct Known Subclasses:

InMemoryHistoryManager, PreferencesHistoryManager

public abstract class HistoryManager<T>
extends Object

The HistoryManager class defines the standard operations to manage history storage for any type of items, allowing for implementation of various data storage mechanisms.

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<Predicate<T>>	filter	Returns the property object for the filter used when adding items to the history.
final javafx.beans.property.IntegerProperty	maxHistorySize	The maximum number of items that the history will store.

Constructor Summary

Constructors

Constructor	Description
HistoryManager()

Method Summary

Modifier and Type	Method	Description
final void	add(List<T> items)	Adds the given items to the history.
final void	add(T item)	Adds the given item to the history.
final void	clear()	Clears the history.
final javafx.beans.property.ObjectProperty<Predicate<T>>	filterProperty()	Returns the property object for the filter used when adding items to the history.
final javafx.collections.ObservableList<T>	getAllUnmodifiable()	Returns an unmodifiable list of the history.
final Predicate<T>	getFilter()	Gets the value of the property filter.
final int	getMaxHistorySize()	Gets the value of the property maxHistorySize.
protected abstract void	loadHistory()
final javafx.beans.property.IntegerProperty	maxHistorySizeProperty()	The maximum number of items that the history will store.
final void	remove(List<T> items)	Removes the given items from the history.
final boolean	remove(T item)	Removes the given item from the history.
final void	set(List<T> history)	Sets the history of the HistoryManager with the provided list of strings.
final void	setFilter(Predicate<T> filter)	Sets the value of the property filter.
final void	setMaxHistorySize(int maxHistorySize)	Sets the value of the property maxHistorySize.
protected abstract void	storeHistory()

Methods inherited from class java.lang.Object

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

Property Details

maxHistorySize

public final javafx.beans.property.IntegerProperty maxHistorySizeProperty

The maximum number of items that the history will store. If the number of items exceeds this value, the oldest items will be removed.

See Also:

• getMaxHistorySize()
• setMaxHistorySize(int)

filter

public final javafx.beans.property.ObjectProperty<Predicate<T>> filterProperty

Returns the property object for the filter used when adding items to the history. Only items that pass the filter will be added to the history.

See Also:

• getFilter()
• setFilter(Predicate)

Constructor Details

HistoryManager

public HistoryManager()

Method Details

loadHistory

protected abstract void loadHistory()

storeHistory

protected abstract void storeHistory()

set

public final void set(List<T> history)

Sets the history of the HistoryManager with the provided list of strings. The method ensures that duplicates are removed from the list.

Parameters:

history - the list of strings representing the history

add

public final void add(T item)

Adds the given item to the history. The method ensures that duplicates will not be added.

Parameters:

item - the item to add

add

public final void add(List<T> items)

Adds the given items to the history.

Parameters:

items - the items to add

remove

public final boolean remove(T item)

Removes the given item from the history.

Parameters:

item - the item to remove

Returns:

true if the item was removed, false otherwise

remove

public final void remove(List<T> items)

Removes the given items from the history.

Parameters:

items - the items to remove

clear

public final void clear()

Clears the history.

getAllUnmodifiable

public final javafx.collections.ObservableList<T> getAllUnmodifiable()

Returns an unmodifiable list of the history.

maxHistorySizeProperty

public final javafx.beans.property.IntegerProperty maxHistorySizeProperty()

The maximum number of items that the history will store. If the number of items exceeds this value, the oldest items will be removed.

See Also:

• getMaxHistorySize()
• setMaxHistorySize(int)

getMaxHistorySize

public final int getMaxHistorySize()

Gets the value of the property maxHistorySize.

Property description:

The maximum number of items that the history will store. If the number of items exceeds this value, the oldest items will be removed.

setMaxHistorySize

public final void setMaxHistorySize(int maxHistorySize)

Sets the value of the property maxHistorySize.

Property description:

The maximum number of items that the history will store. If the number of items exceeds this value, the oldest items will be removed.

filterProperty

public final javafx.beans.property.ObjectProperty<Predicate<T>> filterProperty()

Returns the property object for the filter used when adding items to the history. Only items that pass the filter will be added to the history.

See Also:

• getFilter()
• setFilter(Predicate)

getFilter

public final Predicate<T> getFilter()

Gets the value of the property filter.

Property description:

Returns the property object for the filter used when adding items to the history. Only items that pass the filter will be added to the history.

setFilter

public final void setFilter(Predicate<T> filter)

Sets the value of the property filter.

Property description:

Returns the property object for the filter used when adding items to the history. Only items that pass the filter will be added to the history.