org.sbolstandard.core2

Enum RestrictionType

java.lang.Object

java.lang.Enum<RestrictionType>

org.sbolstandard.core2.RestrictionType

All Implemented Interfaces:

Serializable, Comparable<RestrictionType>

public enum RestrictionType
extends Enum<RestrictionType>

Represents the relationship between a sequence constraint's subject and object components.

Version:

2.1

Author:

Zhen Zhang, Chris Myers

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIFFERENT_FROM The definition property of the subject Component MUST NOT refer to the same ComponentDefinition as that of the object Component.
OPPOSITE_ORIENTATION_AS The subject and object Component objects MUST have opposite orientations.
PRECEDES The position of the subject Component MUST precede that of the object Component.
SAME_ORIENTATION_AS The subject and object Component objects MUST have the same orientation.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRECEDES

public static final RestrictionType PRECEDES

The position of the subject Component MUST precede that of the object Component. If each one is associated with a SequenceAnnotation, then the SequenceAnnotation associated with the subject Component MUST specify a region that starts before the region specified by the SequenceAnnotation associated with the object Component.

SAME_ORIENTATION_AS

public static final RestrictionType SAME_ORIENTATION_AS

The subject and object Component objects MUST have the same orientation. If each one is associated with a SequenceAnnotation, then the orientation URIs of the Location objects of the first SequenceAnnotation MUST be represented among those of the second SequenceAnnotation, and vice versa.

OPPOSITE_ORIENTATION_AS

public static final RestrictionType OPPOSITE_ORIENTATION_AS

The subject and object Component objects MUST have opposite orientations. If each one is associated with a SequenceAnnotation, then the orientation URIs of the Location objects of one SequenceAnnotation MUST NOT be represented among those of the other SequenceAnnotation.

DIFFERENT_FROM

public static final RestrictionType DIFFERENT_FROM

The definition property of the subject Component MUST NOT refer to the same ComponentDefinition as that of the object Component.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<RestrictionType>