HelixOrigin (BioCommons 3.0.4 API)

java.lang.Object
- java.lang.Enum<HelixOrigin>
- - pl.poznan.put.structure.HelixOrigin

All Implemented Interfaces:

Serializable, Comparable<HelixOrigin>
```
public enum HelixOrigin
extends Enum<HelixOrigin>
```
An information whether a base pair originated from a helix.

Enum Constant Summary

Enum Constants
Enum Constant Description

FALSE

TRUE

UNKNOWN

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`toOneLetter()`
`String`	`toString()`
`static HelixOrigin`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static HelixOrigin[]`	`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
  - UNKNOWN
```
public static final HelixOrigin UNKNOWN
```
  - TRUE
```
public static final HelixOrigin TRUE
```
  - FALSE
```
public static final HelixOrigin FALSE
```
- Method Detail
  - values
```
public static HelixOrigin[] 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 (HelixOrigin c : HelixOrigin.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HelixOrigin valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<HelixOrigin>
  - toOneLetter
```
public String toOneLetter()
```
    Returns:
    
    A one letter representation of this instance.