Enum Class ToneMarkerType

java.lang.Object

java.lang.Enum<ToneMarkerType>

ca.phon.orthography.ToneMarkerType

All Implemented Interfaces:

Serializable, Comparable<ToneMarkerType>, Constable

public enum ToneMarkerType
extends Enum<ToneMarkerType>

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
FALLING_TO_LOW
FALLING_TO_MID
LEVEL
RISING_TO_HIGH
RISING_TO_MID

Method Summary

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

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RISING_TO_HIGH

@Documentation("https://talkbank.org/manuals/CHAT.html#RisingToHigh")
public static final ToneMarkerType RISING_TO_HIGH

RISING_TO_MID

@Documentation("https://talkbank.org/manuals/CHAT.html#RisingToMid")
public static final ToneMarkerType RISING_TO_MID

LEVEL

@Documentation("https://talkbank.org/manuals/CHAT.html#Level")
public static final ToneMarkerType LEVEL

FALLING_TO_MID

@Documentation("https://talkbank.org/manuals/CHAT.html#FallingToMid")
public static final ToneMarkerType FALLING_TO_MID

FALLING_TO_LOW

@Documentation("https://talkbank.org/manuals/CHAT.html#FallingToLow")
public static final ToneMarkerType FALLING_TO_LOW

Method Details

values

public static ToneMarkerType[] 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 ToneMarkerType 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

getChar

public char getChar()

getDisplayName

public String getDisplayName()

toString

public String toString()

Overrides:

toString in class Enum<ToneMarkerType>

fromString

public static ToneMarkerType fromString(String text)