org.dishevelled.bio.assembly.gfa

Class Reference

java.lang.Object

org.dishevelled.bio.assembly.gfa.Reference

@Immutable
public final class Reference
extends Object

Reference.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
Reference(String id, Orientation orientation) Create a new reference.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getId() Return the identifier for this reference.
Orientation	getOrientation() Return the orientation for this reference.
int	hashCode()
boolean	isForwardOrientation() Return true if the orientation for this reference is Orientation.FORWARD.
boolean	isReverseOrientation() Return true if the orientation for this reference is Orientation.REVERSE.
String	splitToString() Return this reference as a string split by the tab character.
static Reference	splitValueOf(String id, String orientation) Parse a reference from the specified values.
String	toString()
static Reference	valueOf(String value) Parse a reference from the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference(String id,
                 Orientation orientation)

Create a new reference.

Parameters:

id - identifier, must not be null

orientation - orientation, must not be null

Method Detail

getId

public String getId()

Return the identifier for this reference.

Returns:

the identifier for this reference

getOrientation

public Orientation getOrientation()

Return the orientation for this reference.

Returns:

the orientation for this reference

isForwardOrientation

public boolean isForwardOrientation()

Return true if the orientation for this reference is Orientation.FORWARD.

Returns:

true if the orientation for this reference is Orientation.FORWARD

isReverseOrientation

public boolean isReverseOrientation()

Return true if the orientation for this reference is Orientation.REVERSE.

Returns:

true if the orientation for this reference is Orientation.REVERSE

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

splitToString

public String splitToString()

Return this reference as a string split by the tab character.

Returns:

this reference as a string split by the tab character

valueOf

public static Reference valueOf(String value)

Parse a reference from the specified value.

Parameters:

value - value, must not be null

Returns:

a reference parsed from the specified value

splitValueOf

public static Reference splitValueOf(String id,
                                     String orientation)

Parse a reference from the specified values.

Parameters:

id - id, must not be null

orientation - orientation, must be one of {+,-}

Returns:

a reference parsed from the specified values