de.carne.util.prefs

Class PathPreference

java.lang.Object

de.carne.util.prefs.Preference<java.nio.file.Path>

de.carne.util.prefs.PathPreference

public class PathPreference
extends Preference<java.nio.file.Path>

Utility class providing access to a Path preference.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Predicate<java.nio.file.Path>	IS_DIRECTORY Files.isDirectory(Path, java.nio.file.LinkOption...) validator.
static java.util.function.Predicate<java.nio.file.Path>	IS_REGULAR_FILE Files.isRegularFile(Path, java.nio.file.LinkOption...) validator.

Constructor Summary

Constructors

Constructor and Description
PathPreference(java.util.prefs.Preferences preferences, java.lang.String key) Construct PathPreference.
PathPreference(java.util.prefs.Preferences preferences, java.lang.String key, java.util.function.Predicate<java.nio.file.Path> validator) Construct PathPreference.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	fromValue(java.nio.file.Path value) Convert the preference value to it's string representation.
java.io.File	getValueAsFile() Get the preference value as a File object.
java.io.File	getValueAsFile(java.io.File defaultValue) Get the preference value as a File object.
void	putValueFromFile(java.io.File value) Set the preference value from a File object.
protected java.nio.file.Path	toValue(java.lang.String valueString) Convert the preference's string representation to it's value.

Methods inherited from class de.carne.util.prefs.Preference

get, get, key, preferences, put, remove, toString

Methods inherited from class java.lang.Object

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

Field Detail

IS_REGULAR_FILE

public static final java.util.function.Predicate<java.nio.file.Path> IS_REGULAR_FILE

Files.isRegularFile(Path, java.nio.file.LinkOption...) validator.

IS_DIRECTORY

public static final java.util.function.Predicate<java.nio.file.Path> IS_DIRECTORY

Files.isDirectory(Path, java.nio.file.LinkOption...) validator.

Constructor Detail

PathPreference

public PathPreference(java.util.prefs.Preferences preferences,
                      java.lang.String key)

Construct PathPreference.

Parameters:

preferences - The Preferences object storing this preference.

key - The preference key.

PathPreference

public PathPreference(java.util.prefs.Preferences preferences,
                      java.lang.String key,
                      java.util.function.Predicate<java.nio.file.Path> validator)

Construct PathPreference.

Parameters:

preferences - The Preferences object storing this preference.

key - The preference key.

validator - Predicate to use for preference value validation.

Method Detail

getValueAsFile

@Nullable
public java.io.File getValueAsFile()

Get the preference value as a File object.

Returns:

The found preference value, or null if the preference is undefined.

getValueAsFile

@Nullable
public java.io.File getValueAsFile(@Nullable
                                             java.io.File defaultValue)

Get the preference value as a File object.

Parameters:

defaultValue - The default preference value to return in case the preference is undefined.

Returns:

The found preference value.

putValueFromFile

public void putValueFromFile(@Nullable
                             java.io.File value)

Set the preference value from a File object.

Parameters:

value - The value to set. If null the preference is removed.

toValue

@Nullable
protected java.nio.file.Path toValue(java.lang.String valueString)

Description copied from class: Preference

Convert the preference's string representation to it's value.

Specified by:

toValue in class Preference<java.nio.file.Path>

Parameters:

valueString - The string to convert.

Returns:

The converted preference value.

fromValue

protected java.lang.String fromValue(java.nio.file.Path value)

Description copied from class: Preference

Convert the preference value to it's string representation.

Specified by:

fromValue in class Preference<java.nio.file.Path>

Parameters:

value - The value to convert.

Returns:

The converted preference value.