org.biojava.nbio.phylo

Enum TreeType

java.lang.Object

java.lang.Enum<TreeType>

org.biojava.nbio.phylo.TreeType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TreeType>

public enum TreeType
extends java.lang.Enum<TreeType>

The TreeType specifies the optimization criteria used to generate the tree.

Since:

4.1.1

Author:

Aleix Lafita

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTANCE Distance Tree
ML Maximum Likelihood Tree
PARSIMONY Parsimony Tree

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	name Description name of the Tree Type

Method Summary

Modifier and Type	Method and Description
static TreeType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TreeType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ML

public static final TreeType ML

Maximum Likelihood Tree

DISTANCE

public static final TreeType DISTANCE

Distance Tree

PARSIMONY

public static final TreeType PARSIMONY

Parsimony Tree

Field Detail

name

protected final java.lang.String name

Description name of the Tree Type

Method Detail

values

public static TreeType[] 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 (TreeType c : TreeType.values())
    System.out.println(c);

Returns:

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

valueOf

public static TreeType 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