com.physpics.tools.ui

Class PropertyPack.SaveCluster

java.lang.Object

com.physpics.tools.ui.PropertyPack.Cluster

com.physpics.tools.ui.PropertyPack.DirCluster

com.physpics.tools.ui.PropertyPack.SaveCluster

Enclosing class:

PropertyPack

public class PropertyPack.SaveCluster
extends PropertyPack.DirCluster

A single-file cluster that allows saving properties into its file. Should be the first cluster. Does NOT search for variants. To accommodate variants, A FileCluster may be added for the same file.

Field Summary

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

propNodeList

Constructor Summary

Constructors

Constructor and Description
SaveCluster(File sink) Construct a SaveCluster targeting a given file

Method Summary

Modifier and Type	Method and Description
int	addPropNodes() Add a single SaveNode.
protected void	createSaveNode() Ensure that saveNode has a value.
InputStream	openFile(java.lang.String relName) Opens a file in same directory as the saveNode.
java.lang.String	toString()

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

countPropNodes, equals, forEachProperty, forEachPropNode, getURL, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveCluster

public SaveCluster(File sink)

Construct a SaveCluster targeting a given file

Parameters:

sink - File where property changes should be saved

Method Detail

createSaveNode

protected void createSaveNode()

Ensure that saveNode has a value. Called by addPropNodes, but also called by setProvisionalProperty.

addPropNodes

public int addPropNodes()

Add a single SaveNode.

Overrides:

addPropNodes in class PropertyPack.Cluster

Returns:

the number of propnodes in the cluster

openFile

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

Opens a file in same directory as the saveNode.

Overrides:

openFile in class PropertyPack.DirCluster

Parameters:

relName - name within dir. This name may end artificially with SAVENODE_FILENAME_APPENDAGE, which must be stripped.

Returns:

an InputStream for the file, or null

Throws:

IOException - IO error

toString

public java.lang.String toString()

Overrides:

toString in class PropertyPack.DirCluster

Returns:

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