com.physpics.tools.ui

Class PropertyPack.URLCluster

java.lang.Object

com.physpics.tools.ui.PropertyPack.Cluster

com.physpics.tools.ui.PropertyPack.URLCluster

Enclosing class:

PropertyPack

public class PropertyPack.URLCluster
extends PropertyPack.Cluster

A URL cluster is for URLs other than file:, usually http:.

Field Summary

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

propNodeList

Constructor Summary

Constructors

Constructor and Description
URLCluster(java.net.URL u) Construct a Cluster that reads files relative to an URL.
URLCluster(java.net.URL location, java.lang.String stem) Construct a Cluster that looks in a given URL under a given stem name.

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

URLCluster

public URLCluster(java.net.URL u)

Construct a Cluster that reads files relative to an URL. When a file is requested, the file's name is appended to the URL.

Parameters:

u - The URL to look under. Any fragment (#xxxx) is discarded. A file extension is deleted. The resulting name is prepended to requests.

URLCluster

public URLCluster(java.net.URL location,
                  java.lang.String stem)

Construct a Cluster that looks in a given URL under a given stem name.

Parameters:

location - root of the URL. If there is no trailing slash, one is added

stem - the prefix for properties files names. Any leading slash is deleted.

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.)