Package com.microsoft.cognitiveservices.speech

Enum ProfanityOption

java.lang.Object

java.lang.Enum<ProfanityOption>

com.microsoft.cognitiveservices.speech.ProfanityOption

All Implemented Interfaces:

Serializable, Comparable<ProfanityOption>

public enum ProfanityOption
extends Enum<ProfanityOption>

Define profanity option for response result. Added in version 1.5.0.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Masked	Replaces profanity with asterisks.
Raw	Includes the profanity in the result.
Removed	Removes all profanity from the result.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the internal value of profanity option.
static ProfanityOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProfanityOption[]	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

Masked

public static final ProfanityOption Masked

Replaces profanity with asterisks.

Removed

public static final ProfanityOption Removed

Removes all profanity from the result.

Raw

public static final ProfanityOption Raw

Includes the profanity in the result.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Returns the internal value of profanity option.

Returns:

the internal profanity value.