org.micromanager

Interface PropertyManager

public interface PropertyManager

Provides access to PropertyMaps. And instance of this interface is obtained through Studio.properties() and Studio.propertyManager();

Method Summary

Modifier and Type	Method and Description
PropertyMap	emptyPropertyMap() Returns an empty property map.
PropertyMap	fromJSON(java.lang.String json) Creates a property map from its JSON-serialized form.
PropertyMap	loadJSON(java.io.File file) Create a property map from its JSON-serialized form stored in a file.
PropertyMap.Builder	propertyMapBuilder() Provides an easy way for a script to obtain a PropertyMap Builder.

Method Detail

propertyMapBuilder

PropertyMap.Builder propertyMapBuilder()

Provides an easy way for a script to obtain a PropertyMap Builder.

Returns:

PropertyMap Builder

emptyPropertyMap

PropertyMap emptyPropertyMap()

Returns an empty property map.

Returns:

empty property map

fromJSON

PropertyMap fromJSON(java.lang.String json)
              throws java.io.IOException

Creates a property map from its JSON-serialized form. JSON format is described in PropertyMapJSONSerializer.

Parameters:

json - json formatted String to be converted into a PropertyMap

Returns:

PropertyMap result from conversion

Throws:

java.io.IOException - if json is invalid JSON or if it does not represent a valid property map

loadJSON

PropertyMap loadJSON(java.io.File file)
              throws java.io.IOException

Create a property map from its JSON-serialized form stored in a file. JSON format is described in PropertyMapJSONSerializer.

Parameters:

file - File containing JSON serialized Properties.

Returns:

PropertyMap resulting from conversion fo JSON in file.

Throws:

java.io.IOException - if there was a problem reading file or if the file contained invalid JSON or if the JSON did not represent a valid property map

java.io.FileNotFoundException - this subclass of IOException is thrown if file does not exist