io.micronaut.aws.alexa.ssml

Enum WordRole

java.lang.Object

java.lang.Enum<WordRole>

io.micronaut.aws.alexa.ssml.WordRole

All Implemented Interfaces:

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

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

Word role used to customize the pronunciation of words by specifying the word's part of speech.

Since:

2.0.0

Author:

sdelamo

See Also:

SSML W.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NN Interpret the word as a noun.
SENSE_1 Use the non-default sense of the word.
VB Interpret the word as a verb (present simple).
VBD Interpret the word as a past participle.

Method Summary

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

VB

public static final WordRole VB

Interpret the word as a verb (present simple).

VBD

public static final WordRole VBD

Interpret the word as a past participle.

NN

public static final WordRole NN

Interpret the word as a noun.

SENSE_1

public static final WordRole SENSE_1

Use the non-default sense of the word. For example, the noun "bass" is pronounced differently depending on meaning.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<WordRole>