Package org.biojavax.bio.seq

Class RichLocation.Strand

java.lang.Object
org.biojavax.bio.seq.RichLocation.Strand
All Implemented Interfaces:
Comparable
Enclosing interface:
RichLocation
public static class RichLocation.Strand extends Object implements Comparable
This class represents a strand on which a location may lie. Three strands are defined by default - UNKNOWN, NEGATIVE, and POSITIVE.

  • Field Details

  • Method Details

    • forValue

      public static RichLocation.Strand forValue(int value)
      Returns the strand object that matches the number given. Throws an exception if it could not recognise the number. Number is usually 1,-1,0.
      Parameters:
      value - the number of the strand.
      Returns:
      the strand matching that number.

    • forName

      public static RichLocation.Strand forName(String name)
      Returns the strand object that matches the symbol given. Throws an exception if it could not recognise the symbol. Symbol is usually +,-,?.
      Parameters:
      name - the symbol of the strand.
      Returns:
      the strand matching that symbol.

    • intValue

      public int intValue()
      Returns the numeric value of this strand.
      Returns:
      the numeric value.

    • getName

      public String getName()
      Returns the string symbol of this strand.
      Returns:
      the string symbol.

    • toString

      public String toString()
      Form: "symbol" (eg. +,-,?)
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Strands are equal if their numbers and symbols match.
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(Object o)
      Strands are compared first by symbol, then by number.
      Specified by:
      compareTo in interface Comparable