Package edu.cmu.tetrad.graph

Enum Class Endpoint

java.lang.Object

java.lang.Enum<Endpoint>

edu.cmu.tetrad.graph.Endpoint

All Implemented Interfaces:

TetradSerializable, Serializable, Comparable<Endpoint>, Constable

public enum Endpoint
extends Enum<Endpoint>
implements TetradSerializable

A enumeration of the endpoint types that are permitted in Tetrad-style graphs: null (-), arrow (->), circle (-o), start (-*), and null (no endpoint).

Version:

$Id: $Id

Author:

josephramsey

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
ARROW	Arrow endpoint.
CIRCLE	Circle endpoint.
NULL	No endpoint.
STAR	Star endpoint.
TAIL	Tail endpoint.

Method Summary

Modifier and Type	Method	Description
static Endpoint	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Endpoint[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TAIL

public static final Endpoint TAIL

Tail endpoint.

ARROW

public static final Endpoint ARROW

Arrow endpoint.

CIRCLE

public static final Endpoint CIRCLE

Circle endpoint.

STAR

public static final Endpoint STAR

Star endpoint.

NULL

public static final Endpoint NULL

No endpoint.

Method Details

values

public static Endpoint[] values()

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

Returns:

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

valueOf

public static Endpoint valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null