htsjdk.variant.variantcontext

Enum StructuralVariantType

java.lang.Object

java.lang.Enum<StructuralVariantType>

htsjdk.variant.variantcontext.StructuralVariantType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StructuralVariantType>

public enum StructuralVariantType
extends java.lang.Enum<StructuralVariantType>

Type of Structural Variant as defined in the VCF spec 4.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
BND breakend structural variation.
CNV Copy number variable region
DEL Deletion relative to the reference
DUP Region of elevated copy number relative to the reference
INS Insertion of novel sequence relative to the reference
INV Inversion of reference sequence

Method Summary

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

DEL

public static final StructuralVariantType DEL

Deletion relative to the reference

INS

public static final StructuralVariantType INS

Insertion of novel sequence relative to the reference

DUP

public static final StructuralVariantType DUP

Region of elevated copy number relative to the reference

INV

public static final StructuralVariantType INV

Inversion of reference sequence

CNV

public static final StructuralVariantType CNV

Copy number variable region

BND

public static final StructuralVariantType BND

breakend structural variation. VCF Specification : An arbitrary rearrangement event can be summarized as a set of novel adjacencies. Each adjacency ties together two breakends.

Method Detail

values

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

Returns:

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

valueOf

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