Package org.cytoscape.property

Class AbstractConfigDirPropsReader

java.lang.Object
org.cytoscape.property.AbstractConfigDirPropsReader
All Implemented Interfaces:
CyProperty<Properties>
public abstract class AbstractConfigDirPropsReader extends Object implements CyProperty<Properties>
An abstract implementation of CyProperty<Properties> that attempts to read the specified properties file first from the jar file running this code and then appends any properties found in the local configuration directory to that properties object. The config directory used is CyProperty.DEFAULT_PROPS_CONFIG_DIR.
This class must be extended so that it will read from the proper jar file. In general simply implementing a constructor should be sufficient: 
        public class PropsReader extends AbstractConfigDirPropsReader {
                PropsReader(String s, SavePolicy sp) {
                        super(s,sp);
                }
        }

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: property-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>property-api</artifactId>
</dependency>

  • Field Details

    • name

      protected final String name
      The name of this CyProperty.

    • props

      protected final Properties props
      The Properties object created for this class.

    • savePolicy

      protected final CyProperty.SavePolicy savePolicy
      The SavePolicy of this CyProperty.

  • Constructor Details

    • AbstractConfigDirPropsReader

      public AbstractConfigDirPropsReader​(String name, String propFileName, CyProperty.SavePolicy savePolicy)
      Creates a new AbstractConfigDirPropsReader object.
      Parameters:
      name - The name of this CyProperty.
      propFileName - The name of the java.util.Properties file to read.
      savePolicy - The save policy for this CyProperty. This value MUST be either CyProperty.SavePolicy.CONFIG_DIR or CyProperty.SavePolicy.SESSION_FILE_AND_CONFIG_DIR so that we can reasonably expect to find a properties file in the configuration directory. If you'd like to use a different SavePolicy, then consider using SimpleCyProperty instead.

  • Method Details