de.javagl.common.ui.properties

Class PropertiesManager

java.lang.Object

de.javagl.common.ui.properties.PropertiesManager

public class PropertiesManager
extends Object

A class for managing properties of an application that should be maintained in a properties file.

Constructor Summary

Constructors

Constructor and Description
PropertiesManager(PropertiesHandle propertiesHandle) Creates a new instance that uses the given PropertiesHandle

Method Summary

Modifier and Type	Method and Description
void	detachSaveOnClose(Window window) Detaches the listener that was attached to the given window when it was passed to saveOnClose(Window)
void	registerColor(String name, Supplier<? extends Color> supplier, Consumer<? super Color> consumer) Register the given supplier and consumer under the given name
void	registerDouble(String name, DoubleSupplier supplier, DoubleConsumer consumer) Register the given supplier and consumer under the given name
void	registerInteger(String name, IntSupplier supplier, IntConsumer consumer) Register the given supplier and consumer under the given name
void	registerPath(String name, Supplier<? extends Path> supplier, Consumer<? super Path> consumer) Register the given supplier and consumer under the given name
void	registerPoint(String name, Supplier<? extends Point> supplier, Consumer<? super Point> consumer) Register the given supplier and consumer under the given name
void	registerRectangle(String name, Supplier<? extends Rectangle> supplier, Consumer<? super Rectangle> consumer) Register the given supplier and consumer under the given name
void	registerString(String name, Supplier<? extends String> supplier, Consumer<? super String> consumer) Register the given supplier and consumer under the given name
void	restore() Restore the state, by passing all values from the properties file to the registered consumers.
void	save() Save the current state, by obtaining all values from the registered suppliers, and writing them into the properties file
void	saveOnClose(Window window) Attach a listener to the given window that will save the properties when the window is closed

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesManager

public PropertiesManager(PropertiesHandle propertiesHandle)

Creates a new instance that uses the given PropertiesHandle

Parameters:

propertiesHandle - The PropertiesHandle

Method Detail

registerString

public void registerString(String name,
                           Supplier<? extends String> supplier,
                           Consumer<? super String> consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerInteger

public void registerInteger(String name,
                            IntSupplier supplier,
                            IntConsumer consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerDouble

public void registerDouble(String name,
                           DoubleSupplier supplier,
                           DoubleConsumer consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerPath

public void registerPath(String name,
                         Supplier<? extends Path> supplier,
                         Consumer<? super Path> consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerPoint

public void registerPoint(String name,
                          Supplier<? extends Point> supplier,
                          Consumer<? super Point> consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerRectangle

public void registerRectangle(String name,
                              Supplier<? extends Rectangle> supplier,
                              Consumer<? super Rectangle> consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

registerColor

public void registerColor(String name,
                          Supplier<? extends Color> supplier,
                          Consumer<? super Color> consumer)

Register the given supplier and consumer under the given name

Parameters:

name - The name

supplier - The supplier

consumer - The consumer

save

public void save()

Save the current state, by obtaining all values from the registered suppliers, and writing them into the properties file

restore

public void restore()

Restore the state, by passing all values from the properties file to the registered consumers.

saveOnClose

public void saveOnClose(Window window)

Attach a listener to the given window that will save the properties when the window is closed

Parameters:

window - The window

detachSaveOnClose

public void detachSaveOnClose(Window window)

Detaches the listener that was attached to the given window when it was passed to saveOnClose(Window)

Parameters:

window - The window