Package com.azure.ai.translation.text.models

Enum ProfanityAction

java.lang.Object

java.lang.Enum<ProfanityAction>

com.azure.ai.translation.text.models.ProfanityAction

All Implemented Interfaces:

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

public enum ProfanityAction
extends Enum<ProfanityAction>

Translator profanity actions.

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
DELETED	Profanity is deleted from the translated text.
MARKED	Profanity is marked.
NO_ACTION	No Action is taken on profanity.

Method Summary

Modifier and Type	Method	Description
static ProfanityAction	fromString(String value)	Parses a serialized value to a ProfanityAction instance.
String	toString()
static ProfanityAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ProfanityAction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_ACTION

public static final ProfanityAction NO_ACTION

No Action is taken on profanity.

MARKED

public static final ProfanityAction MARKED

Profanity is marked.

DELETED

public static final ProfanityAction DELETED

Profanity is deleted from the translated text.

Method Details

values

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

fromString

public static ProfanityAction fromString(String value)

Parses a serialized value to a ProfanityAction instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed ProfanityAction object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<ProfanityAction>