org.pharmgkb.parser.vcf.model

Enum ReservedStructuralVariantCode

java.lang.Object

java.lang.Enum<ReservedStructuralVariantCode>

org.pharmgkb.parser.vcf.model.ReservedStructuralVariantCode

All Implemented Interfaces:

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

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

A reserved identifier for VCF ALT codes of structural variants. Each reserved identifier has a level.

See Also:

AltStructuralVariant

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cnv
Deletion
Duplication
Insertion
Inversion
MobileElement
Tandem

Method Summary

Modifier and Type	Method and Description
static ReservedStructuralVariantCode	fromId(java.lang.String id)
java.lang.String	getId()
int	getLevelInSpecification()
java.util.List<ReservedStructuralVariantCode>	getParentCodes()
static ReservedStructuralVariantCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ReservedStructuralVariantCode[]	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

Deletion

public static final ReservedStructuralVariantCode Deletion

Insertion

public static final ReservedStructuralVariantCode Insertion

Duplication

public static final ReservedStructuralVariantCode Duplication

Inversion

public static final ReservedStructuralVariantCode Inversion

Cnv

public static final ReservedStructuralVariantCode Cnv

Tandem

public static final ReservedStructuralVariantCode Tandem

MobileElement

public static final ReservedStructuralVariantCode MobileElement

Method Detail

values

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

Returns:

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

valueOf

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

fromId

@Nullable
public static ReservedStructuralVariantCode fromId(@Nonnull
                                                              java.lang.String id)

getId

public java.lang.String getId()

Returns:

The code (e.g. CNV)

getLevelInSpecification

public int getLevelInSpecification()

getParentCodes

public java.util.List<ReservedStructuralVariantCode> getParentCodes()