Strand (htsjdk 2.14.3 API)

java.lang.Object
- java.lang.Enum<Strand>
- - htsjdk.tribble.annotation.Strand

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Strand>
```
public enum Strand
extends java.lang.Enum<Strand>
```
Enum for strand, which can be encoded as a string

Enum Constant Summary

Enum Constants
Enum Constant and Description
`NEGATIVE` Represents the negative or reverse strand.
`NONE` Denotes that a strand designation is not applicable or is unknown.
`POSITIVE` Represents the positive or forward strand.

Field Summary

Fields
Modifier and Type Field and Description

static Strand FORWARD
Common alias for the POSITIVE strand.

static Strand REVERSE
Common alias for the NEGATIVE strand.

Fields
Modifier and Type	Field and Description
`static Strand`	`FORWARD` Common alias for the `POSITIVE` strand.
`static Strand`	`REVERSE` Common alias for the `NEGATIVE` strand.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Strand`	`decode(char ch)` Returns the `Strand` that a `char` value represents.
`static Strand`	`decode(java.lang.String encoding)` Returns the `Strand` that a `String` encodes for.
`java.lang.String`	`encode()` Returns a string representation of this `Strand`
`char`	`encodeAsChar()` Returns a single char encoding of this `Strand`.
`static Strand`	`toStrand(java.lang.String encoding)` Deprecated. please use `decode(char)` instead.
`java.lang.String`	`toString()`
`static Strand`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Strand[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - POSITIVE
```
public static final Strand POSITIVE
```
    Represents the positive or forward strand.
  - NEGATIVE
```
public static final Strand NEGATIVE
```
    Represents the negative or reverse strand.
  - NONE
```
public static final Strand NONE
```
    Denotes that a strand designation is not applicable or is unknown.
- Field Detail
  - FORWARD
```
public static final Strand FORWARD
```
    Common alias for the POSITIVE strand.
  - REVERSE
```
public static final Strand REVERSE
```
    Common alias for the NEGATIVE strand.
- Method Detail
  - values
```
public static Strand[] 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 (Strand c : Strand.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Strand 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 name
    
    java.lang.NullPointerException - if the argument is null
  - toStrand
```
@Deprecated
public static Strand toStrand(java.lang.String encoding)
```
    Deprecated. please use decode(char) instead.
    
    provide a way to take an encoding string, and produce a Strand
    
    Parameters:
    
    encoding - the encoding string
    
    Returns:
    
    a Strand object, if an appropriate one cannot be located an IllegalArg exception
  - decode
```
public static Strand decode(char ch)
```
    Returns the Strand that a char value represents.
    
    Parameters:
    
    ch - the char encoding for a Strand.
    
    Returns:
    
    never null, a value so that decode(c).encodeAsChar() == c or NONE if the encoding char is not recognized.
  - decode
```
public static Strand decode(java.lang.String encoding)
```
    Returns the Strand that a String encodes for.
    
    Parameters:
    
    encoding - the strand string representation.
    
    Returns:
    
    never null, a value so that decode(s).encode().equals(s), or NONE if the encoding string is not recognized.
  - encode
```
public java.lang.String encode()
```
    Returns a string representation of this Strand
    
    Returns:
    
    never null, a value so that decode(encode(X)) == X.
  - encodeAsChar
```
public char encodeAsChar()
```
    Returns a single char encoding of this Strand.
    
    Returns:
    
    a value so that decode(encodeAsChar(X)) == X.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<Strand>

Enum Strand

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

POSITIVE

NEGATIVE

NONE

Field Detail

FORWARD

REVERSE

Method Detail

values

valueOf

toStrand

decode

decode

encode

encodeAsChar

toString