GfaRecord (dsh-bio-assembly 1.3.2 API)

java.lang.Object
- org.dishevelled.bio.assembly.gfa.GfaRecord

Direct Known Subclasses:

Gfa1Record, Gfa2Record
```
public abstract class GfaRecord
extends Object
```
Graphical Fragment Assembly (GFA) record.

Author:

Michael Heuer

Constructor Summary

Constructors
Modifier Constructor and Description

protected GfaRecord(Map<String,Tag> tags)
Create a new GFA record with the specified tags.

Constructors
Modifier	Constructor and Description
`protected`	`GfaRecord(Map<String,Tag> tags)` Create a new GFA record with the specified tags.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsTagKey(String key)` Return true if this GFA record contains the specified tag key.
`byte[]`	`getTagByteArray(String key)` Return the Type=H field value for the specified key parsed into a byte array.
`Optional<byte[]>`	`getTagByteArrayOpt(String key)` Return an optional wrapping the Type=H field value for the specified key parsed into a byte array.
`List<Byte>`	`getTagBytes(String key)` Return the Type=H field value for the specified key parsed into an immutable list of bytes.
`Optional<List<Byte>>`	`getTagBytesOpt(String key)` Return an optional wrapping the Type=H field value for the specified key parsed into an immutable list of bytes.
`char`	`getTagCharacter(String key)` Return the Type=A field value for the specified key parsed into a character.
`Optional<Character>`	`getTagCharacterOpt(String key)` Return an optional wrapping the Type=A field value for the specified key parsed into a character.
`float`	`getTagFloat(String key)` Return the Type=f field value for the specified key parsed into a float.
`Optional<Float>`	`getTagFloatOpt(String key)` Return an optional wrapping the Type=f field value for the specified key parsed into a float.
`List<Float>`	`getTagFloats(String key)` Return the Type=B first letter f field value for the specified key parsed into an immutable list of floats.
`Optional<List<Float>>`	`getTagFloatsOpt(String key)` Return an optional wrapping the Type=B first letter f field value for the specified key parsed into an immutable list of floats.
`int`	`getTagInteger(String key)` Return the Type=i field value for the specified key parsed into an integer.
`Optional<Integer>`	`getTagIntegerOpt(String key)` Return an optional wrapping the Type=i field value for the specified key parsed into an integer.
`List<Integer>`	`getTagIntegers(String key)` Return the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers.
`Optional<List<Integer>>`	`getTagIntegersOpt(String key)` Return an optional wrapping the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers.
`Map<String,Tag>`	`getTags()` Return an immutable map of tags keyed by tag name for this GFA record.
`String`	`getTagString(String key)` Return the Type=Z field value for the specified key parsed into a string.
`Optional<String>`	`getTagStringOpt(String key)` Return an optional wrapping the Type=Z field value for the specified key parsed into a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GfaRecord
```
protected GfaRecord(Map<String,Tag> tags)
```
    Create a new GFA record with the specified tags.
    
    Parameters:
    
    tags - tags, must not be null
- Method Detail
  - getTags
```
public final Map<String,Tag> getTags()
```
    Return an immutable map of tags keyed by tag name for this GFA record.
    
    Returns:
    
    an immutable map of tags keyed by tag name for this GFA record
  - containsTagKey
```
public final boolean containsTagKey(String key)
```
    Return true if this GFA record contains the specified tag key.
    
    Parameters:
    
    key - key
    
    Returns:
    
    true if this GFA record contains the specified tag key
  - getTagCharacter
```
public final char getTagCharacter(String key)
```
    Return the Type=A field value for the specified key parsed into a character.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=A field value for the specified key parsed into a character
  - getTagFloat
```
public final float getTagFloat(String key)
```
    Return the Type=f field value for the specified key parsed into a float.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=f field value for the specified key parsed into a float
  - getTagInteger
```
public final int getTagInteger(String key)
```
    Return the Type=i field value for the specified key parsed into an integer.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=i field value for the specified key parsed into an integer
  - getTagByteArray
```
public final byte[] getTagByteArray(String key)
```
    Return the Type=H field value for the specified key parsed into a byte array.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=H field value for the specified key parsed into a byte array
  - getTagBytes
```
public final List<Byte> getTagBytes(String key)
```
    Return the Type=H field value for the specified key parsed into an immutable list of bytes.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=H field value for the specified key parsed into an immutable list of bytes
  - getTagString
```
public final String getTagString(String key)
```
    Return the Type=Z field value for the specified key parsed into a string.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=Z field value for the specified key parsed into a string
  - getTagFloats
```
public final List<Float> getTagFloats(String key)
```
    Return the Type=B first letter f field value for the specified key parsed into an immutable list of floats.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=B first letter f field value for the specified key parsed into an immutable list of floats
  - getTagIntegers
```
public final List<Integer> getTagIntegers(String key)
```
    Return the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers
  - getTagCharacterOpt
```
public final Optional<Character> getTagCharacterOpt(String key)
```
    Return an optional wrapping the Type=A field value for the specified key parsed into a character.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=A field value for the specified key parsed into a character
  - getTagFloatOpt
```
public final Optional<Float> getTagFloatOpt(String key)
```
    Return an optional wrapping the Type=f field value for the specified key parsed into a float.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=f field value for the specified key parsed into a float
  - getTagIntegerOpt
```
public final Optional<Integer> getTagIntegerOpt(String key)
```
    Return an optional wrapping the Type=i field value for the specified key parsed into an integer.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=i field value for the specified key parsed into an integer
  - getTagStringOpt
```
public final Optional<String> getTagStringOpt(String key)
```
    Return an optional wrapping the Type=Z field value for the specified key parsed into a string.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=Z field value for the specified key parsed into a string
  - getTagByteArrayOpt
```
public final Optional<byte[]> getTagByteArrayOpt(String key)
```
    Return an optional wrapping the Type=H field value for the specified key parsed into a byte array.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=H field value for the specified key parsed into a byte array
  - getTagBytesOpt
```
public final Optional<List<Byte>> getTagBytesOpt(String key)
```
    Return an optional wrapping the Type=H field value for the specified key parsed into an immutable list of bytes.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=H field value for the specified key parsed into an immutable list of bytes
  - getTagFloatsOpt
```
public final Optional<List<Float>> getTagFloatsOpt(String key)
```
    Return an optional wrapping the Type=B first letter f field value for the specified key parsed into an immutable list of floats.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=B first letter f field value for the specified key parsed into an immutable list of floats
  - getTagIntegersOpt
```
public final Optional<List<Integer>> getTagIntegersOpt(String key)
```
    Return an optional wrapping the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers.
    
    Parameters:
    
    key - key, must not be null
    
    Returns:
    
    an optional wrapping the Type=B first letter [cCsSiI] field value for the specified key parsed into an immutable list of integers

Class GfaRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GfaRecord

Method Detail

getTags

containsTagKey

getTagCharacter

getTagFloat

getTagInteger

getTagByteArray

getTagBytes

getTagString

getTagFloats

getTagIntegers

getTagCharacterOpt

getTagFloatOpt

getTagIntegerOpt

getTagStringOpt

getTagByteArrayOpt

getTagBytesOpt

getTagFloatsOpt

getTagIntegersOpt