Package org.cytoscape.property

Enum CyProperty.SavePolicy

  • All Implemented Interfaces:
    Serializable, Comparable<CyProperty.SavePolicy>
    Enclosing interface:
    CyProperty<P>
    public static enum CyProperty.SavePolicy
extends Enum<CyProperty.SavePolicy>
    SavePolicy specifies how the CyProperty will be saved, or if it will not be saved.

    Cytoscape Backwards Compatibility (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

    • Enum Constant Detail

      • DO_NOT_SAVE

        public static final CyProperty.SavePolicy DO_NOT_SAVE
        These properties are preset by Cytoscape to some default value and are never written out.

      • CONFIG_DIR

        public static final CyProperty.SavePolicy CONFIG_DIR
        These properties are loaded from and written to the default config directory and are user defaults.

      • SESSION_FILE

        public static final CyProperty.SavePolicy SESSION_FILE
        These properties will be loaded from and saved to session files.

      • SESSION_FILE_AND_CONFIG_DIR

        public static final CyProperty.SavePolicy SESSION_FILE_AND_CONFIG_DIR
        These properties will be loaded from and saved to session files and the default config directory. (Settings in a session file will overwrite those from the default config directory.)

    • Method Detail

      • values

        public static CyProperty.SavePolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (CyProperty.SavePolicy c : CyProperty.SavePolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CyProperty.SavePolicy valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null