org.cytoscape.io

Enum DataCategory

java.lang.Object

java.lang.Enum<DataCategory>

org.cytoscape.io.DataCategory

All Implemented Interfaces:

Serializable, Comparable<DataCategory>

public enum DataCategory
extends Enum<DataCategory>

An enum that captures the types of data the IO package can read and write.

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: io-api

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVE Data to be exported is an archive file
IMAGE Data to be import/export is Image
NETWORK Data to be import/export is NETWORK
PROPERTIES Data to be import/export is Properties
SCRIPT Data to be imported is Script file
SESSION Data to be import/export is CySession
TABLE Data to be import/export is Table
UNSPECIFIED Data to be import/export is not specified (unknown)
VIZMAP Data to be import/export is VizMap

Method Summary

Modifier and Type	Method and Description
String	getDisplayName()
static DataCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataCategory[]	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

NETWORK

public static final DataCategory NETWORK

Data to be import/export is NETWORK

TABLE

public static final DataCategory TABLE

Data to be import/export is Table

IMAGE

public static final DataCategory IMAGE

Data to be import/export is Image

PROPERTIES

public static final DataCategory PROPERTIES

Data to be import/export is Properties

SESSION

public static final DataCategory SESSION

Data to be import/export is CySession

VIZMAP

public static final DataCategory VIZMAP

Data to be import/export is VizMap

SCRIPT

public static final DataCategory SCRIPT

Data to be imported is Script file

ARCHIVE

public static final DataCategory ARCHIVE

Data to be exported is an archive file

UNSPECIFIED

public static final DataCategory UNSPECIFIED

Data to be import/export is not specified (unknown)

Method Detail

values

public static DataCategory[] 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 (DataCategory c : DataCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataCategory 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

getDisplayName

public String getDisplayName()