Package com.biomatters.geneious.publicapi.documents.sequence

Enum SequenceAnnotationInterval.Direction

java.lang.Object

java.lang.Enum<SequenceAnnotationInterval.Direction>

com.biomatters.geneious.publicapi.documents.sequence.SequenceAnnotationInterval.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SequenceAnnotationInterval.Direction>

Enclosing class:

SequenceAnnotationInterval

public static enum SequenceAnnotationInterval.Direction
extends java.lang.Enum<SequenceAnnotationInterval.Direction>

The direction of a sequence annotation interval. One of leftToRight, rightToLeft, none or bothWays.

Enum Constant Summary

Enum Constants

Enum Constant	Description
bothWays
leftToRight
none
rightToLeft

Method Summary

Modifier and Type	Method	Description
boolean	isDirectedLeft()
boolean	isDirectedRight()
SequenceAnnotationInterval.Direction	reverse()	The opposite direction from this one, i.e.
java.lang.String	toArrowString()
static SequenceAnnotationInterval.Direction	valueOf(boolean isDirectedLeft, boolean isDirectedRight)
static SequenceAnnotationInterval.Direction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SequenceAnnotationInterval.Direction[]	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

leftToRight

public static final SequenceAnnotationInterval.Direction leftToRight

rightToLeft

public static final SequenceAnnotationInterval.Direction rightToLeft

none

public static final SequenceAnnotationInterval.Direction none

bothWays

public static final SequenceAnnotationInterval.Direction bothWays

Method Detail

values

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

Returns:

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

valueOf

public static SequenceAnnotationInterval.Direction valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isDirectedLeft

public final boolean isDirectedLeft()

isDirectedRight

public final boolean isDirectedRight()

valueOf

public static SequenceAnnotationInterval.Direction valueOf(boolean isDirectedLeft,
                                                           boolean isDirectedRight)

Parameters:

isDirectedLeft - whether the desired direction should point left

isDirectedRight - whether the desired direction should point right

Returns:

A direction d with d.isDirectedLeft()==isDirectedLeft and d.isDirectedRight==isDirectedRight

reverse

public SequenceAnnotationInterval.Direction reverse()

The opposite direction from this one, i.e. the same as this direction if the direction is symmetric, and otherwise the mirrored direction.

Returns:

opposite direction

toArrowString

public java.lang.String toArrowString()

Returns:

This direction represented as a text arrow, one of { "-", "<-", "->" "<->"}.