org.pharmgkb.parser.vcf.model

Enum SpecialVcfNumber

java.lang.Object

java.lang.Enum<SpecialVcfNumber>

org.pharmgkb.parser.vcf.model.SpecialVcfNumber

All Implemented Interfaces:

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

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

A reserved value for the "Number" field in INFO and FORMAT metadata entries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ONE_PER_ALT
ONE_PER_ALT_OR_REF
ONE_PER_GENOTYPE
UNKNOWN_OR_UNBOUNDED

Method Summary

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

ONE_PER_ALT

public static final SpecialVcfNumber ONE_PER_ALT

ONE_PER_ALT_OR_REF

public static final SpecialVcfNumber ONE_PER_ALT_OR_REF

ONE_PER_GENOTYPE

public static final SpecialVcfNumber ONE_PER_GENOTYPE

UNKNOWN_OR_UNBOUNDED

public static final SpecialVcfNumber UNKNOWN_OR_UNBOUNDED

Method Detail

values

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

Returns:

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

valueOf

public static SpecialVcfNumber 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 SpecialVcfNumber fromId(@Nonnull
                                                 java.lang.String id)

getId

@Nonnull
public java.lang.String getId()