Enum Class Frame

Method Details

• values

  public static Frame[] values()

  Returns an array containing the constants of this enum class, in the order they are declared.

  Returns:

  an array containing the constants of this enum class, in the order they are declared

• valueOf

  public static Frame valueOf(String name)

  Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  IllegalArgumentException - if this enum class has no constant with the specified name

  NullPointerException - if the argument is null

• getDefaultFrame

  public static Frame getDefaultFrame()

• getForwardFrames

  public static Frame[] getForwardFrames()

  Returns all frames in the forward orientation

• getReverseFrames

  public static Frame[] getReverseFrames()

  Returns all frames which are in the reverse orientation

• getAllFrames

  public static Frame[] getAllFrames()

  Delegates to values()

• wrap

  public <C extends NucleotideCompound> Sequence<C> wrap(Sequence<C> incoming)

  Optionally wraps a Sequence in a reverse complementing view (if the frame is on the reverse strand) and creates a sub sequence view if it is required. If you pass in ONE in you will get the same Sequence returned.