org.sbolstandard.core2

Enum RefinementType

java.lang.Object

java.lang.Enum<RefinementType>

org.sbolstandard.core2.RefinementType

All Implemented Interfaces:

Serializable, Comparable<RefinementType>

public enum RefinementType
extends Enum<RefinementType>

Represents the refinement relationship between a MapsTo instance's local and remote components.

Version:

2.1

Author:

Zhen Zhang, Chris Myers

Enum Constant Summary

Enum Constants

Enum Constant and Description
MERGE In the context of the ComponentDefinition or ModuleDefinition that contains the owner of the MapsTo, all references to the definition property of the local ComponentInstance or that of the remote ComponentInstance MUST dereference to both properties.
USELOCAL In the context of the ComponentDefinition or ModuleDefinition that contains the owner of the MapsTo, all references to the definition property of the remote ComponentInstance MUST dereference to that of the local ComponentInstance instead.
USEREMOTE All references to the definition property of the local ComponentInstance MUST dereference to that of the remote ComponentInstance instead.
VERIFYIDENTICAL The definition properties of the local and remote ComponentInstance objects MUST refer to the same ComponentDefinition.

Method Summary

Modifier and Type	Method and Description
String	toString()
static RefinementType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RefinementType[]	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

VERIFYIDENTICAL

public static final RefinementType VERIFYIDENTICAL

The definition properties of the local and remote ComponentInstance objects MUST refer to the same ComponentDefinition.

USELOCAL

public static final RefinementType USELOCAL

In the context of the ComponentDefinition or ModuleDefinition that contains the owner of the MapsTo, all references to the definition property of the remote ComponentInstance MUST dereference to that of the local ComponentInstance instead.

USEREMOTE

public static final RefinementType USEREMOTE

All references to the definition property of the local ComponentInstance MUST dereference to that of the remote ComponentInstance instead.

MERGE

public static final RefinementType MERGE

In the context of the ComponentDefinition or ModuleDefinition that contains the owner of the MapsTo, all references to the definition property of the local ComponentInstance or that of the remote ComponentInstance MUST dereference to both properties.

Method Detail

values

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

Returns:

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

valueOf

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