org.globus.gridshib.common
Class StringMapFile

java.lang.Object
  org.globus.gridshib.common.LoadableResource
      org.globus.gridshib.common.StringMapFile

All Implemented Interfaces:

Loadable

Direct Known Subclasses:

EntityMapFile

public class StringMapFile
extends LoadableResource

An implementation of the Loadable interface for string maps, that is maps of String into String.

See Also:

Loadable, LoadableResource

Field Summary

Fields inherited from class org.globus.gridshib.common.LoadableResource

lastLoaded, loaded, resource

Constructor Summary

StringMapFile(File file)
The primary constructor for obtaining an instance of StringMapFile.

StringMapFile(String pathname)
A convenience constructor that simply converts its String argument into a File object, and then calls the corresponding constructor.

StringMapFile(URI uri)
A convenience constructor that simply converts its URI argument into a File object, and then calls the corresponding constructor.

Method Summary

String	get(String key) Gets the string value that corresponds to the given key.
static StringMapFile	getInstance(File file) Gets the instance of StringMapFile that corresponds to the given file.
static StringMapFile	getInstance(String pathname) Creates a File object from the given pathname and invokes #getInstance(File).
static StringMapFile	getInstance(URI uri) Creates a File object from the given URI instance and invokes #getInstance(File).
Set	getKeySet() Gets all the (String) keys associated with this instance.
void	load() Loads the file and calls #resetLastLoaded().

Methods inherited from class org.globus.gridshib.common.LoadableResource

getLastLoaded, getResource, isLoaded, isStale, resetLastLoaded, toURL, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

StringMapFile

public StringMapFile(URI uri)
              throws LoadException

A convenience constructor that simply converts its URI argument into a File object, and then calls the corresponding constructor.

Throws:

LoadException

StringMapFile

public StringMapFile(String pathname)
              throws LoadException

A convenience constructor that simply converts its String argument into a File object, and then calls the corresponding constructor.

Throws:

LoadException

StringMapFile

public StringMapFile(File file)
              throws LoadException

The primary constructor for obtaining an instance of StringMapFile. Captures the given File object and loads the file.

Throws:

LoadException

Method Detail

getInstance

public static StringMapFile getInstance(URI uri)
                                 throws LoadException

Creates a File object from the given URI instance and invokes #getInstance(File).

Parameters:

uri - the URI of the file that backs this instance of StringMapFile

Returns:

the one and only one StringMapFile instance that corresponds to the given URI

Throws:

LoadException - if a new instance of StringMapFile is required but the file fails to load

getInstance

public static StringMapFile getInstance(String pathname)
                                 throws LoadException

Creates a File object from the given pathname and invokes #getInstance(File).

Parameters:

pathname - the pathname of the file that backs this instance of StringMapFile

Returns:

the one and only one StringMapFile instance that corresponds to the given pathname

Throws:

LoadException - if a new instance of StringMapFile is required but the file fails to load

getInstance

public static StringMapFile getInstance(File file)
                                 throws LoadException

Gets the instance of StringMapFile that corresponds to the given file. Such an instance may have been created previously, in which case that instance is returned directly. Otherwise, a new instance of StringMapFile is created and returned.

Use of this method (as opposed to the direct use of the constructor) prevents needless reloading of a file that may have already been loaded.

Parameters:

file - the file that backs this instance of StringMapFile

Returns:

the one and only one StringMapFile instance that corresponds to the given file

Throws:

LoadException - if a new instance of StringMapFile is required but the file fails to load

See Also:

StringMapFile(File)

getKeySet

public Set getKeySet()
              throws LoadException

Gets all the (String) keys associated with this instance. If this Loadable object is stale, reload it first.

Returns:

the keys associated with this StringMapFile instance

Throws:

LoadException - If unable to reload the Loadable object (if stale)

get

public String get(String key)
           throws LoadException

Gets the string value that corresponds to the given key. If this Loadable object is stale, reload it first.

Parameters:

key - a string key

Returns:

the string value corresponding to the given key

Throws:

LoadException - If unable to reload the Loadable object (if stale)

load

public void load()
          throws LoadException

Loads the file and calls #resetLastLoaded().

Throws:

LoadException - If unable to load this Loadable object

See Also:

Loadable