com.physpics.tools.ui

Class PropertyPack.JarCluster

java.lang.Object

com.physpics.tools.ui.PropertyPack.Cluster

com.physpics.tools.ui.PropertyPack.JarCluster

Enclosing class:

PropertyPack

public class PropertyPack.JarCluster
extends PropertyPack.Cluster

A JarCluster accesses files inside a jar. (Confusingly, files within a jar are elsewhere called "resources"). The jar may be an actual .jar file or in NetBeans it may be build/classes/, which is going to be wrapped into the jar.

Field Summary

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

propNodeList

Constructor Summary

Constructors

Constructor and Description
JarCluster(java.lang.Object obj, java.lang.String stemPath) Construct a JarCluster for a particular object and stem.
JarCluster(java.lang.Object obj, java.lang.String stem, java.lang.ClassLoader load) Construct a JarCluster with the jar of an object, a stem path, and a classloader.

Method Summary

Modifier and Type	Method and Description
InputStream	openFile(java.lang.String relName)
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

JarCluster

public JarCluster(java.lang.Object obj,
                  java.lang.String stemPath)

Construct a JarCluster for a particular object and stem. For details of the parameters, see the other constructor.

Parameters:

obj - Indicates Class to use for finding jar and choosing a C;lassLoader.

stemPath - Location within the jar of the property files; a slash-separated list of parent directories. The last element is the name of the properties file, from which locale variants and the extension are stripped.

JarCluster

public JarCluster(java.lang.Object obj,
                  java.lang.String stem,
                  java.lang.ClassLoader load)

Construct a JarCluster with the jar of an object, a stem path, and a classloader.

Parameters:

obj - Indicates an object in the same jar file as the required properties file. If obj is itself a Class object, the jar file will be that of the class's members. This value contributes only to the URL imputed for objects of this Cluster. Otherwise the cluster's jar file is implicit in the ClassLoader.

stem - Path location of the properties file within the jar. It is a slash-separated sequence of the elements of the binary name of the properties file. No leading slash. Extension and locale suffixes (_xx) are deleted. The stem value must also indicate the directory within the jar. The directory is derived thus:

• Dots are converted to slashes.
• A leading slash is inserted if absent.
• If the stem ends with slash (or dot), packName is appended.

For files at the top-level of the jar, the stem should be the file name, or "" for packName.

load - A ClassLoader. Usually that of the first parameter (as provided by the other constructor).

Method Detail

openFile

public InputStream openFile(java.lang.String relName)

Specified by:

openFile in class PropertyPack.Cluster

Parameters:

relName - location of the desired file within the cluster. Usually this method is called from createPropNode; in this case relName is a locale suffix and an extension. To open a sibling of the properties file, relName may be /../siblingname.ext.

Returns:

an InputStream for the file at relName in the cluster. The cluster's memberStem is prepended to the name.

The client MUST close the stream. Accordingly, an IOException may thrown. This is intended to encourage calling this method from within the parenthesized resouces clause of a try statement.

toString

public java.lang.String toString()

Specified by:

toString in class PropertyPack.Cluster

Returns:

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