org.dishevelled.bio.assembly.gfa1

Class Header

java.lang.Object

org.dishevelled.bio.assembly.gfa.GfaRecord

org.dishevelled.bio.assembly.gfa1.Gfa1Record

org.dishevelled.bio.assembly.gfa1.Header

@Immutable
public final class Header
extends Gfa1Record

Header GFA 1.0 record.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
Header(Map<String,Tag> tags) Create a new header GFA 1.0 record.

Method Summary

Modifier and Type	Method and Description
boolean	containsVersionNumber() Return true if the tags for this header contain the reserved key VN, for version number.
boolean	containsVn() Return true if the tags for this header contain the reserved key VN.
boolean	equals(Object o)
String	getVersionNumber() Return the version number for this header (Type=Z value for the reserved key VN as a string).
Optional<String>	getVersionNumberOpt() Return an optional wrapping the version number for this header (Type Z value for the reserved key VN as a string).
String	getVn() Return the Type=Z value for the reserved key VN as a string.
Optional<String>	getVnOpt() Return an optional Type=Z value for the reserved key VN as a string.
int	hashCode()
String	toString()
static Header	valueOf(String value) Parse a header GFA 1.0 record from the specified value.

Methods inherited from class org.dishevelled.bio.assembly.gfa.GfaRecord

containsTagKey, getTagByteArray, getTagByteArrayOpt, getTagBytes, getTagBytesOpt, getTagCharacter, getTagCharacterOpt, getTagFloat, getTagFloatOpt, getTagFloats, getTagFloatsOpt, getTagInteger, getTagIntegerOpt, getTagIntegers, getTagIntegersOpt, getTags, getTagString, getTagStringOpt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Header

public Header(Map<String,Tag> tags)

Create a new header GFA 1.0 record.

Parameters:

tags - tags, must not be null

Method Detail

containsVn

public boolean containsVn()

Return true if the tags for this header contain the reserved key VN.

Returns:

true if the tags for this header contain the reserved key VN

getVn

public String getVn()

Return the Type=Z value for the reserved key VN as a string.

Returns:

the Type=Z value for the reserved key VN as a string

getVnOpt

public Optional<String> getVnOpt()

Return an optional Type=Z value for the reserved key VN as a string.

Returns:

an optional Type=Z value for the reserved key VN as a string

containsVersionNumber

public boolean containsVersionNumber()

Return true if the tags for this header contain the reserved key VN, for version number.

Returns:

true if the tags for this header contain the reserved key VN, for version number

getVersionNumber

public String getVersionNumber()

Return the version number for this header (Type=Z value for the reserved key VN as a string).

Returns:

the version number for this header (Type=Z value for the reserved key VN as a string)

getVersionNumberOpt

public Optional<String> getVersionNumberOpt()

Return an optional wrapping the version number for this header (Type Z value for the reserved key VN as a string).

Returns:

an optional wrapping the version number for this header (Type Z value for the reserved key VN as a string)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static Header valueOf(String value)

Parse a header GFA 1.0 record from the specified value.

Parameters:

value - value, must not be null

Returns:

a header GFA 1.0 record parsed from the specified value