org.dishevelled.bio.assembly.gfa2

Class Path

java.lang.Object

org.dishevelled.bio.assembly.gfa.GfaRecord

org.dishevelled.bio.assembly.gfa2.Gfa2Record

org.dishevelled.bio.assembly.gfa2.Path

@Immutable
public final class Path
extends Gfa2Record

Path GFA 2.0 record.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
Path(String id, List<Reference> references, Map<String,Tag> tags) Create a new path GFA 2.0 record.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId() Return the identifier for this path, if any.
Optional<String>	getIdOpt() Return an optional wrapping the identifier for this path.
List<Reference>	getReferences() Return an immutable list of references for this path.
int	hashCode()
boolean	hasId() Return true if this path has an identifier.
String	toString()
static Path	valueOf(String value) Parse a path GFA 2.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

Path

public Path(@Nullable
            String id,
            List<Reference> references,
            Map<String,Tag> tags)

Create a new path GFA 2.0 record.

Parameters:

id - identifier, if any

references - list of reference, must not be null

tags - tags, must not be null

Method Detail

hasId

public boolean hasId()

Return true if this path has an identifier.

Returns:

true if this path has an identifier

Since:

1.3.2

getId

public String getId()

Return the identifier for this path, if any.

Returns:

the identifier for this path, if any

getIdOpt

public Optional<String> getIdOpt()

Return an optional wrapping the identifier for this path.

Returns:

an optional wrapping the identifier for this path

getReferences

public List<Reference> getReferences()

Return an immutable list of references for this path.

Returns:

an immutable list of references for this path

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 Path valueOf(String value)

Parse a path GFA 2.0 record from the specified value.

Parameters:

value - value, must not be null

Returns:

a path GFA 2.0 record parsed from the specified value