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

Enum ProfanityMarker

java.lang.Object

java.lang.Enum<ProfanityMarker>

com.azure.ai.translation.text.models.ProfanityMarker

All Implemented Interfaces:

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

public enum ProfanityMarker
extends Enum<ProfanityMarker>

Translator profanity markers.

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
ASTERISK	Profanity is marked with asterisk.
TAG	Profanity is marked with the tags.

Method Summary

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

ASTERISK

public static final ProfanityMarker ASTERISK

Profanity is marked with asterisk.

TAG

public static final ProfanityMarker TAG

Profanity is marked with the tags.

Method Details

values

public static ProfanityMarker[] 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 ProfanityMarker 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 ProfanityMarker fromString(String value)

Parses a serialized value to a ProfanityMarker instance.

Parameters:

value - the serialized value to parse.

Returns:

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

toString

public String toString()

Overrides:

toString in class Enum<ProfanityMarker>