com.physpics.tools.ui

Class PropertyPack.DirCluster

java.lang.Object

com.physpics.tools.ui.PropertyPack.Cluster

com.physpics.tools.ui.PropertyPack.DirCluster

Direct Known Subclasses:

PropertyPack.SaveCluster

Enclosing class:

PropertyPack

public class PropertyPack.DirCluster
extends PropertyPack.Cluster

A DirCluster is a collection of files within a local directory each having a given stem name. A PropNode is generated for each file in this Cluster named

    {stemName}{variant}{ext}

where

{stemName}

is the name prefix given in the constructor. Default packStem

{variant}

is one of the possible variants of the current Locale. Each begins with '_'

{ext}

is one of .properties, .xml, or .class

Field Summary

Fields inherited from class com.physpics.tools.ui.PropertyPack.Cluster

propNodeList

Constructor Summary

Constructors

Constructor and Description
DirCluster(File f) Construct a cluster that refers to a file and its locale/extension variants.
DirCluster(File d, java.lang.String stem) Construct a DirCluster that reads from a directory those property files that have a given stem.
DirCluster(java.lang.String fnm) Construct a cluster for a directory and optional file stem.

Method Summary

Modifier and Type	Method and Description
InputStream	openFile(java.lang.String relName) Return an open InputStream ready to read the contents of the object.
java.lang.String	toString()

Methods inherited from class com.physpics.tools.ui.PropertyPack.Cluster

addPropNodes, countPropNodes, equals, forEachProperty, forEachPropNode, getURL, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DirCluster

public DirCluster(java.lang.String fnm)

Construct a cluster for a directory and optional file stem. The file stem is everything after the last slash. Thus if there is no file stem, the name must end in slash. If the stem is omitted, it defaults to 'packStem'.

Parameters:

fnm - name of a directory or a file within a directory. The directory must be absolute and readable. If fnm refers to a directory, the stem is that of the PropertyPack; otherwise the stem is fnm stripped of directories, locale variants, and extension.

DirCluster

public DirCluster(File f)

Construct a cluster that refers to a file and its locale/extension variants. If the file is not a directory, the file's basename is taken as the stem; otherwise, the stem is the cluster's packStem.

Parameters:

f - A File denoting a directory and an optional file within it. The directory must be absolute and refer to a readable directory. If there is no file, the stem is taken to be packStem; otherwise the cluster's stem is the file name stripped of its extension and any locale suffix(es) beginning with '_'.

DirCluster

public DirCluster(File d,
                  java.lang.String stem)

Construct a DirCluster that reads from a directory those property files that have a given stem.

Parameters:

d - the root directory of the Cluster. It must be absolute and readable.

stem - prefix for properties file names. It will be stripped of a file extension and any suffixes beginning with '_'.

Method Detail

openFile

public InputStream openFile(java.lang.String relName)
                     throws IOException

Return an open InputStream ready to read the contents of the object. The caller must close the file; usually via try-with-resources. To encourage file closure, IOExceptions are passed to the caller.

Specified by:

openFile in class PropertyPack.Cluster

Parameters:

relName - slash-separated relative path to the file within this Cluster's location.

Returns:

An InputStream reading the file contents or null for an error.

Throws:

FileNotFoundException - If file cannot be found

IOException - if an error occurs.

toString

public java.lang.String toString()

Specified by:

toString in class PropertyPack.Cluster

Returns:

(Subclasses should return: classname ":" directory " : " memberStem.)