net.talvi.puffinplot

Class IdToFileMap

java.lang.Object

net.talvi.puffinplot.IdToFileMap

public class IdToFileMap
extends java.lang.Object

A class to maintain a mapping between identifier strings and files.

This is essentially a thin wrapper around a supplied getter and putter method; in the PuffinPlot Swing application, these are supplied by a java.util.prefs.Preferences object, and the IdToFileMap is used to keep track of the last-used directory for various Open File dialogs.

Constructor Summary

Constructors

Constructor and Description
IdToFileMap(java.util.function.UnaryOperator<java.lang.String> getter, java.util.function.BiConsumer<java.lang.String,java.lang.String> putter) Creates a new IdToFileMap, which wwill store and retrieve mappings using the supplied getter and putter.

Method Summary

Modifier and Type	Method and Description
java.io.File	get(java.lang.String identifier) Return the directory associated with an identifier.
java.lang.String	getString(java.lang.String identifier) Return the directory associated with an identifier, as a string.
void	put(java.lang.String identifier, java.io.File directory) Set the directory associated with an identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdToFileMap

public IdToFileMap(java.util.function.UnaryOperator<java.lang.String> getter,
                   java.util.function.BiConsumer<java.lang.String,java.lang.String> putter)

Creates a new IdToFileMap, which wwill store and retrieve mappings using the supplied getter and putter.

Parameters:

getter - a getter method which returns a value for a provided key. For a non-existent key, it should return an empty string.

putter - a fuction which takes a key and a value, and stores the value under the given key.

Method Detail

get

public java.io.File get(java.lang.String identifier)

Return the directory associated with an identifier.

Parameters:

identifier - an identifier

Returns:

the associated directory, or null if there is none

getString

public java.lang.String getString(java.lang.String identifier)

Return the directory associated with an identifier, as a string.

Parameters:

identifier - an identifier

Returns:

a string giving the canonical path of the associated directory, or null if there is none

put

public void put(java.lang.String identifier,
                java.io.File directory)

Set the directory associated with an identifier.

Parameters:

identifier - an identifier (non-null)

directory - the associated directory (non-null)