Package org.biojava.nbio.phylo

Enum TreeType

java.lang.Object

java.lang.Enum<TreeType>

org.biojava.nbio.phylo.TreeType

All Implemented Interfaces:

Serializable, Comparable<TreeType>, java.lang.constant.Constable

public enum TreeType
extends Enum<TreeType>

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

Since:

4.1.1

Author:

Aleix Lafita

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	name	Description name of the Tree Type

Method Summary

Modifier and Type	Method	Description
static TreeType	valueOf(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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

name

protected final String name

Description name of the Tree Type

Method Details

values

public static TreeType[] values()

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

Returns:

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

valueOf

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