org.pharmgkb.parser.vcf.model

Class IdDescriptionMetadata

java.lang.Object

org.pharmgkb.parser.vcf.model.BaseMetadata

org.pharmgkb.parser.vcf.model.IdMetadata

org.pharmgkb.parser.vcf.model.IdDescriptionMetadata

Direct Known Subclasses:

FormatMetadata, InfoMetadata

public class IdDescriptionMetadata
extends IdMetadata

This class represents a single VCF metadata line with an id and description.

In 4.1/4.2:

 ##ALT=<ID=type,Description="description">
 ##FILTER=<ID=ID,Description="description">
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DESCRIPTION
static java.lang.String	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
	IdDescriptionMetadata(java.util.Map<java.lang.String,java.lang.String> properties, boolean isBaseType)
	IdDescriptionMetadata(java.lang.String id, java.lang.String description)
protected	IdDescriptionMetadata(java.lang.String id, java.lang.String description, boolean isBaseType)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()

Methods inherited from class org.pharmgkb.parser.vcf.model.IdMetadata

getId

Methods inherited from class org.pharmgkb.parser.vcf.model.BaseMetadata

ensureNoExtras, getPropertiesRaw, getPropertiesUnquoted, getPropertyKeys, getPropertyRaw, getPropertyUnquoted, putAndQuoteProperty, putPropertyRaw

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

IdDescriptionMetadata

public IdDescriptionMetadata(@Nonnull
                             java.lang.String id,
                             @Nonnull
                             java.lang.String description)

IdDescriptionMetadata

public IdDescriptionMetadata(@Nonnull
                             java.util.Map<java.lang.String,java.lang.String> properties,
                             boolean isBaseType)

IdDescriptionMetadata

protected IdDescriptionMetadata(@Nonnull
                                java.lang.String id,
                                @Nonnull
                                java.lang.String description,
                                boolean isBaseType)

Method Detail

getDescription

@Nullable
public java.lang.String getDescription()

Returns:

Null only when incorrectly constructed without one