de.carne.util.prefs

Class DirectoryPreference

java.lang.Object

de.carne.util.prefs.Preference

de.carne.util.prefs.DirectoryPreference

public final class DirectoryPreference
extends Preference

Utility class for managing a directory preference.

Constructor Summary

Constructors

Constructor and Description
DirectoryPreference(java.lang.String key) Construct DirectoryPreference.

Method Summary

Modifier and Type	Method and Description
java.io.File	getAsFile(java.util.prefs.Preferences preferences) Get the preference value (as File).
java.io.File	getAsFile(java.util.prefs.Preferences preferences, java.io.File defaultDirectory) Get the preference value (as File).
java.nio.file.Path	getAsPath(java.util.prefs.Preferences preferences) Get the preference value (as Path).
java.nio.file.Path	getAsPath(java.util.prefs.Preferences preferences, java.nio.file.Path defaultDirectory) Get the preference value (as Path).
void	set(java.util.prefs.Preferences preferences, java.io.File directory) Set the preference value (from a File object).
void	set(java.util.prefs.Preferences preferences, java.nio.file.Path directory) Set the preference value (from a Path object).
void	setFromFile(java.util.prefs.Preferences preferences, java.io.File file) Set the preference value (from a File object).
void	setFromFile(java.util.prefs.Preferences preferences, java.nio.file.Path file) Set the preference value (from a Path object).

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

key, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryPreference

public DirectoryPreference(java.lang.String key)

Construct DirectoryPreference.

Parameters:

key - The preference key.

Method Detail

getAsFile

public java.io.File getAsFile(java.util.prefs.Preferences preferences)

Get the preference value (as File).

Parameters:

preferences - The Preferences backing up this preference.

Returns:

The preference value or null if the preference is not set.

getAsFile

public java.io.File getAsFile(java.util.prefs.Preferences preferences,
                              java.io.File defaultDirectory)

Get the preference value (as File).

Parameters:

preferences - The Preferences backing up this preference.

defaultDirectory - The default directory to return if the preference is not set.

Returns:

The preference value or the submitted default if the preference is not set.

getAsPath

public java.nio.file.Path getAsPath(java.util.prefs.Preferences preferences)

Get the preference value (as Path).

Parameters:

preferences - The Preferences backing up this preference.

Returns:

The preference value or null if the preference is not set.

getAsPath

public java.nio.file.Path getAsPath(java.util.prefs.Preferences preferences,
                                    java.nio.file.Path defaultDirectory)

Get the preference value (as Path).

Parameters:

preferences - The Preferences backing up this preference.

defaultDirectory - The default directory to return if the preference is not set.

Returns:

The preference value or the submitted default if the preference is not set.

set

public void set(java.util.prefs.Preferences preferences,
                java.io.File directory)

Set the preference value (from a File object).

Parameters:

preferences - The Preferences backing up this preference.

directory - The directory to set. If this parameter is null the preference is removed.

set

public void set(java.util.prefs.Preferences preferences,
                java.nio.file.Path directory)

Set the preference value (from a Path object).

Parameters:

preferences - The Preferences backing up this preference.

directory - The directory to set. If this parameter is null the preference is removed.

setFromFile

public void setFromFile(java.util.prefs.Preferences preferences,
                        java.io.File file)

Set the preference value (from a File object).

Parameters:

preferences - The Preferences backing up this preference.

file - The file to get the directory from. If this parameter is null the preference is removed.

setFromFile

public void setFromFile(java.util.prefs.Preferences preferences,
                        java.nio.file.Path file)

Set the preference value (from a Path object).

Parameters:

preferences - The Preferences backing up this preference.

file - The file to get the directory from. If this parameter is null the preference is removed.