com.physpics.tools.ui

Class PropertyPack.Cluster

java.lang.Object

com.physpics.tools.ui.PropertyPack.Cluster

Direct Known Subclasses:

PropertyPack.BundleCluster, PropertyPack.DirCluster, PropertyPack.JarCluster, PropertyPack.OSEnvCluster, PropertyPack.SystemCluster, PropertyPack.URLCluster

Enclosing class:

PropertyPack

public abstract class PropertyPack.Cluster
extends java.lang.Object

Superclass of all Clusters. A Cluster has a source of files and a stem name. PropertyNodes are generated for each file from the source with a name of the form

    stem{variant}.{ext}

Field Summary

Fields

Modifier and Type	Field and Description
java.util.ArrayList<PropertyPack.PropNode>	propNodeList The PropNodes generated for this cluster.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cluster() Cluster constructor that does not require a stem name.
	Cluster(java.lang.String stem) Construct a Cluster with a specified stem path.

Method Summary

Modifier and Type	Method and Description
int	addPropNodes() Add to propNodes all those with the Cluster's memberName and a possible locale-variant.
int	countPropNodes()
boolean	equals(java.lang.Object o)
void	forEachProperty(java.util.function.Consumer<java.lang.String> sink) Iterate all defined properties, including those in backup properties (although there is no way to create the latter).
void	forEachPropNode(java.util.function.Consumer<PropertyPack.PropNode> sink)
java.net.URL	getURL()
int	hashCode()
abstract InputStream	openFile(java.lang.String relName)
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

propNodeList

public java.util.ArrayList<PropertyPack.PropNode> propNodeList

The PropNodes generated for this cluster.

Constructor Detail

Cluster

protected Cluster()

Cluster constructor that does not require a stem name. It will be set to the default, packStem

Cluster

public Cluster(java.lang.String stem)

Construct a Cluster with a specified stem path.

Parameters:

stem - The memberStem for all files requested of this cluster. It is the path from the top-level of the Cluster's home to all files that will be requested from the Cluster. The path is made to end in slash.

Method Detail

forEachProperty

public void forEachProperty(java.util.function.Consumer<java.lang.String> sink)

Iterate all defined properties, including those in backup properties (although there is no way to create the latter).

Parameters:

sink - a BiConsumer object w/ method accept(String,String)

forEachPropNode

public void forEachPropNode(java.util.function.Consumer<PropertyPack.PropNode> sink)

countPropNodes

public int countPropNodes()

Returns:

the number of PropNodes created for this cluster

getURL

public java.net.URL getURL()

Returns:

An URL whose children are the root for the memberStem members.

openFile

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

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.

Throws:

IOException - if an error occurs.

addPropNodes

public int addPropNodes()

Add to propNodes all those with the Cluster's memberName and a possible locale-variant. For each variant name at most one PropNode is created; the one with the first encountered extension.

An overriding method must check if propNodeList is null and if so, set it to new ArrayList<>();

Returns:

the number of propnodes in the cluster

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

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