Package org.sim0mq.message

Enum Class StringEncoding

java.lang.Object

java.lang.Enum<StringEncoding>

org.sim0mq.message.StringEncoding

All Implemented Interfaces:

Serializable, Comparable<StringEncoding>, Constable

public enum StringEncoding
extends Enum<StringEncoding>

String encoding indicating UTF8 or UTF16 strings.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Aug 9, 2018

Author:

Alexander Verbraeck

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
UTF16	16 bits String and char encoding.
UTF8	8 bits String and char encoding.

Method Summary

Modifier and Type	Method	Description
boolean	isUTF16()	Return whether the string encoding is UTF16.
boolean	isUTF8()	Return whether the string encoding is UTF8.
static StringEncoding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StringEncoding[]	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

UTF8

public static final StringEncoding UTF8

8 bits String and char encoding.

UTF16

public static final StringEncoding UTF16

16 bits String and char encoding.

Method Details

values

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

isUTF8

public boolean isUTF8()

Return whether the string encoding is UTF8.

Returns:

boolean; indicates whether the String encoding is UTF8

isUTF16

public boolean isUTF16()

Return whether the string encoding is UTF16.

Returns:

boolean; indicates whether the String encoding is UTF16