com.google.cloud.language.v1

Enum EncodingType

java.lang.Object

java.lang.Enum<EncodingType>

com.google.cloud.language.v1.EncodingType

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<EncodingType>

public enum EncodingType
extends java.lang.Enum<EncodingType>
implements ProtocolMessageEnum

 Represents the text encoding that the caller uses to process the output.
 Providing an `EncodingType` is recommended because the API provides the
 beginning offsets for various outputs, such as tokens and mentions, and
 languages that natively use different text encodings may access offsets
 differently.
 

Protobuf enum google.cloud.language.v1.EncodingType

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.
UNRECOGNIZED
UTF16 Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input.
UTF32 Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input.
UTF8 Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NONE_VALUE If `EncodingType` is not specified, encoding-dependent information (such as `begin_offset`) will be set at `-1`.
static int	UTF16_VALUE Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-16 encoding of the input.
static int	UTF32_VALUE Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-32 encoding of the input.
static int	UTF8_VALUE Encoding-dependent information (such as `begin_offset`) is calculated based on the UTF-8 encoding of the input.

Method Summary

Modifier and Type	Method and Description
static EncodingType	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<EncodingType>	internalGetValueMap()
static EncodingType	valueOf(Descriptors.EnumValueDescriptor desc)
static EncodingType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static EncodingType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EncodingType[]	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

NONE

public static final EncodingType NONE

 If `EncodingType` is not specified, encoding-dependent information (such as
 `begin_offset`) will be set at `-1`.
 

NONE = 0;

UTF8

public static final EncodingType UTF8

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-8 encoding of the input. C++ and Go are examples of languages
 that use this encoding natively.
 

UTF8 = 1;

UTF16

public static final EncodingType UTF16

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-16 encoding of the input. Java and Javascript are examples of
 languages that use this encoding natively.
 

UTF16 = 2;

UTF32

public static final EncodingType UTF32

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-32 encoding of the input. Python is an example of a language
 that uses this encoding natively.
 

UTF32 = 3;

UNRECOGNIZED

public static final EncodingType UNRECOGNIZED

Field Detail

NONE_VALUE

public static final int NONE_VALUE

 If `EncodingType` is not specified, encoding-dependent information (such as
 `begin_offset`) will be set at `-1`.
 

NONE = 0;

See Also:

Constant Field Values

UTF8_VALUE

public static final int UTF8_VALUE

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-8 encoding of the input. C++ and Go are examples of languages
 that use this encoding natively.
 

UTF8 = 1;

See Also:

Constant Field Values

UTF16_VALUE

public static final int UTF16_VALUE

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-16 encoding of the input. Java and Javascript are examples of
 languages that use this encoding natively.
 

UTF16 = 2;

See Also:

Constant Field Values

UTF32_VALUE

public static final int UTF32_VALUE

 Encoding-dependent information (such as `begin_offset`) is calculated based
 on the UTF-32 encoding of the input. Python is an example of a language
 that uses this encoding natively.
 

UTF32 = 3;

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static EncodingType valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static EncodingType forNumber(int value)

internalGetValueMap

public static Internal.EnumLiteMap<EncodingType> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static EncodingType valueOf(Descriptors.EnumValueDescriptor desc)