Package org.biopax.paxtools.query.algorithm

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

org.biopax.paxtools.query.algorithm.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, java.lang.constant.Constable

public enum Direction
extends Enum<Direction>

Direction is used for specifying upstream, downstream or both. Neighborhood and CommonStream queries use this enum as parameter. The difference between BOTHSTREAM and UNDIRECTED: Both-stream means that the linking paths can be either towards upstream or downstream. A linking path will always be directed towards one direction, i.e. the directions of its relations will be consistent. Undirected means the directions are not considered at all, so a linking path can contain relations towards different directions.

Author:

Ozgun Babur

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTHSTREAM
DOWNSTREAM
UNDIRECTED
UPSTREAM

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UPSTREAM

public static final Direction UPSTREAM

DOWNSTREAM

public static final Direction DOWNSTREAM

BOTHSTREAM

public static final Direction BOTHSTREAM

UNDIRECTED

public static final Direction UNDIRECTED

Method Details

values

public static Direction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Direction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDescription

public String getDescription()

Gets the description.

Returns:

description