Package org.flasby.login2.settings

Class FileSettings

java.lang.Object

org.flasby.login2.settings.FileSettings

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>, PersistentSettings, Settings, SimpleSettings

public final class FileSettings
extends Object
implements PersistentSettings

Nested Class Summary

Nested classes/interfaces inherited from interface org.flasby.login2.settings.Settings

Settings.ApplyWithExistingValue, Settings.ApplyWithMissingKey

Constructor Summary

Constructors

Constructor	Description
FileSettings(String userSettingsFileName)
FileSettings(String userSettingsFileName, boolean mustExist)
FileSettings(Path path)
FileSettings(Path path, boolean mustExist)

Method Summary

Modifier and Type	Method	Description
void	add(String name, String value)
void	delete()	deletes the underlying file used to store the Settings.
void	doIfExists(String key, Settings.ApplyWithExistingValue ifExists)
void	doIfExists(String key, Settings.ApplyWithExistingValue ifExists, Settings.ApplyWithMissingKey otherwise)
String	get(String name)	gets a value from this settings group.
boolean	isEmpty()
Iterator<Map.Entry<String,String>>	iterator()
void	remove(String Name)
void	save()	saves this Settings instance.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FileSettings

public FileSettings(String userSettingsFileName,
 boolean mustExist)
             throws NoSuchFileException

Throws:

NoSuchFileException

FileSettings

public FileSettings(String userSettingsFileName)
             throws NoSuchFileException

Throws:

NoSuchFileException

FileSettings

public FileSettings(Path path)
             throws NoSuchFileException

Throws:

NoSuchFileException

FileSettings

public FileSettings(Path path,
 boolean mustExist)
             throws NoSuchFileException

Throws:

NoSuchFileException

Method Details

get

public String get(String name)

Description copied from interface: SimpleSettings

gets a value from this settings group.

Specified by:

get in interface Settings

Specified by:

get in interface SimpleSettings

Parameters:

name -

Returns:

add

public void add(String name,
 String value)

Specified by:

add in interface SimpleSettings

remove

public void remove(String Name)

Specified by:

remove in interface SimpleSettings

save

public void save()
          throws IOException

Description copied from interface: PersistentSettings

saves this Settings instance.

Specified by:

save in interface PersistentSettings

Throws:

IOException

iterator

public Iterator<Map.Entry<String,String>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,String>>

delete

public void delete()
            throws IOException

deletes the underlying file used to store the Settings. After this call all save() operations will throw exceptions.

Throws:

IOException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Settings

Specified by:

isEmpty in interface SimpleSettings

toString

public String toString()

Overrides:

toString in class Object

doIfExists

public void doIfExists(String key,
 Settings.ApplyWithExistingValue ifExists)

Specified by:

doIfExists in interface Settings

doIfExists

public void doIfExists(String key,
 Settings.ApplyWithExistingValue ifExists,
 Settings.ApplyWithMissingKey otherwise)

Specified by:

doIfExists in interface Settings