Package io.deephaven.base.string

Enum Class EncodingInfo

java.lang.Object

java.lang.Enum<EncodingInfo>

io.deephaven.base.string.EncodingInfo

All Implemented Interfaces:

LogOutputAppendable, Serializable, Comparable<EncodingInfo>, java.lang.constant.Constable

public enum EncodingInfo
extends Enum<EncodingInfo>
implements LogOutputAppendable

Encoding info enum, to help code determine what assumptions it can make about a CharSet, as well as simplification for encode/decode operations.

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
ISO_8859_1
US_ASCII
UTF_16
UTF_16BE
UTF_16LE
UTF_8

Method Summary

Modifier and Type	Method	Description
LogOutput	append(@NotNull LogOutput logOutput)
String	decode(@org.jetbrains.annotations.NotNull byte[] value)
String	decode(@org.jetbrains.annotations.NotNull byte[] value, int offset, int length)
byte[]	encode(@NotNull String value)
Charset	getCharset()
CharsetDecoder	getDecoder()	Get a thread local decoder for this encoding info.
CharsetEncoder	getEncoder()	Get a thread local encoder for this encoding info.
String	getEncodingName()
boolean	isSimple()	Can this encoding info's charset be encoded or decoded by simple linear assignment of char->byte or byte->char.
static EncodingInfo	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EncodingInfo[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

US_ASCII

public static final EncodingInfo US_ASCII

ISO_8859_1

public static final EncodingInfo ISO_8859_1

UTF_8

public static final EncodingInfo UTF_8

UTF_16BE

public static final EncodingInfo UTF_16BE

UTF_16LE

public static final EncodingInfo UTF_16LE

UTF_16

public static final EncodingInfo UTF_16

Method Details

values

public static EncodingInfo[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EncodingInfo valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getEncodingName

public String getEncodingName()

isSimple

public boolean isSimple()

Can this encoding info's charset be encoded or decoded by simple linear assignment of char->byte or byte->char.

Returns:

Whether this encoding info's charset is simple

getCharset

public Charset getCharset()

getEncoder

public CharsetEncoder getEncoder()

Get a thread local encoder for this encoding info.

The encoder will be setup to replace malformed input or unmappable characters, and these settings should be restored if changed.

Returns:

A thread local encoder for this encoding info

getDecoder

public CharsetDecoder getDecoder()

Get a thread local decoder for this encoding info.

The decoder will be setup to replace malformed input or unmappable characters, and these settings should be restored if changed.

Returns:

A thread local decoder for this encoding info

encode

public byte[] encode(@NotNull
 @NotNull String value)

decode

public String decode(@NotNull
 @org.jetbrains.annotations.NotNull byte[] value)

decode

public String decode(@NotNull
 @org.jetbrains.annotations.NotNull byte[] value,
 int offset,
 int length)

append

public LogOutput append(@NotNull
 @NotNull LogOutput logOutput)

Specified by:

append in interface LogOutputAppendable