org.cytoscape.model

Enum SavePolicy

java.lang.Object

java.lang.Enum<SavePolicy>

org.cytoscape.model.SavePolicy

All Implemented Interfaces:

Serializable, Comparable<SavePolicy>

public enum SavePolicy
extends Enum<SavePolicy>

The SavePolicy of an object specifies whether or not it will 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.

Module: model-api

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOT_SAVE The object should not be saved.
SESSION_FILE The object should be saved in the session file.

Method Summary

Modifier and Type	Method and Description
static SavePolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SavePolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DO_NOT_SAVE

public static final SavePolicy DO_NOT_SAVE

The object should not be saved.

SESSION_FILE

public static final SavePolicy SESSION_FILE

The object should be saved in the session file.

Method Detail

values

public static 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 (SavePolicy c : 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 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