Enum Frame
- java.lang.Object
-
- java.lang.Enum<Frame>
-
- org.biojava.nbio.core.sequence.transcription.Frame
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ONE
REVERSED_ONE
REVERSED_THREE
REVERSED_TWO
THREE
TWO
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Frame[]
getAllFrames()
Delegates tovalues()
static Frame
getDefaultFrame()
static Frame[]
getForwardFrames()
Returns all frames in the forward orientationstatic Frame[]
getReverseFrames()
Returns all frames which are in the reverse orientationstatic Frame
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static Frame[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.<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.
-
-
-
Method Detail
-
values
public static Frame[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Frame c : Frame.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Frame valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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
-
wrap
public <C extends NucleotideCompound> Sequence<C> wrap(Sequence<C> incoming)
-
-