org.dishevelled.bio.assembly.gfa

Enum Orientation

java.lang.Object

java.lang.Enum<Orientation>

org.dishevelled.bio.assembly.gfa.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>

public enum Orientation
extends Enum<Orientation>

Orientation.

Author:

Michael Heuer

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORWARD Forward orientation.
REVERSE Reverse orientation.

Method Summary

Modifier and Type	Method and Description
Orientation	flip() Return the orientation opposite of this orientation.
boolean	isForward() Return true if this orientation is Orientation.FORWARD.
boolean	isReverse() Return true if this orientation is Orientation.REVERSE.
static Orientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Orientation[]	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

FORWARD

public static final Orientation FORWARD

Forward orientation.

REVERSE

public static final Orientation REVERSE

Reverse orientation.

Method Detail

values

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

Returns:

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

valueOf

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

isForward

public boolean isForward()

Return true if this orientation is Orientation.FORWARD.

Returns:

true if this orientation is Orientation.FORWARD

isReverse

public boolean isReverse()

Return true if this orientation is Orientation.REVERSE.

Returns:

true if this orientation is Orientation.REVERSE

flip

public Orientation flip()

Return the orientation opposite of this orientation.

Returns:

the orientation opposite of this orientation