org.cytoscape.model
Enum CyEdge.Type

java.lang.Object
  java.lang.Enum<CyEdge.Type>
      org.cytoscape.model.CyEdge.Type

All Implemented Interfaces:

Serializable, Comparable<CyEdge.Type>

Enclosing interface:

CyEdge

public static enum CyEdge.Type
extends Enum<CyEdge.Type>

The Type enum is used by methods in CyNetwork to restrict the edges that match a query.

Enum Constant Summary

ANY
matches any edge

DIRECTED
matches directed edges regardless of whether this node is the source or the target

INCOMING
matches either undirected edges or directed edges that end with this node

OUTGOING
matches either undirected edges or directed edges that start with this node

UNDIRECTED
matches only undirected edges

Method Summary

static CyEdge.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static CyEdge.Type[]	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

UNDIRECTED

public static final CyEdge.Type UNDIRECTED

matches only undirected edges

INCOMING

public static final CyEdge.Type INCOMING

matches either undirected edges or directed edges that end with this node

OUTGOING

public static final CyEdge.Type OUTGOING

matches either undirected edges or directed edges that start with this node

DIRECTED

public static final CyEdge.Type DIRECTED

matches directed edges regardless of whether this node is the source or the target

ANY

public static final CyEdge.Type ANY

matches any edge

Method Detail

values

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

Returns:

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

valueOf

public static CyEdge.Type 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