Package com.quanser.communications

Enum QuanserStream.CharacterFormat

java.lang.Object

java.lang.Enum<QuanserStream.CharacterFormat>

com.quanser.communications.QuanserStream.CharacterFormat

All Implemented Interfaces:

Serializable, Comparable<QuanserStream.CharacterFormat>, java.lang.constant.Constable

Enclosing class:

QuanserStream

public static enum QuanserStream.CharacterFormat
extends Enum<QuanserStream.CharacterFormat>

Enumerates the different character formats available for textual communications. The QuanserStream class supports the reception and transmission of formatted text. The text may be formatted using UTF-8, UTF-16 or UTF-32 characters. The character format of the stream only determines the characters actually sent or received over the underlying communication channel. The text is converted to the native format of the language invoking the QuanserStream methods when performing textual I/O.

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
auto	Determine character format automatically (requires BOM for UTF-16 and UTF-32)
utf16	UTF-16 characters (two byte code unit, up to 2 code units per character)
utf32	UTF-32 characters (four byte code unit, always one code unit per character)
utf8	UTF-8 characters (one byte code unit, up to 4 code units per character)

Method Summary

Modifier and Type	Method	Description
static QuanserStream.CharacterFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static QuanserStream.CharacterFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

auto

public static final QuanserStream.CharacterFormat auto

Determine character format automatically (requires BOM for UTF-16 and UTF-32)

utf8

public static final QuanserStream.CharacterFormat utf8

UTF-8 characters (one byte code unit, up to 4 code units per character)

utf16

public static final QuanserStream.CharacterFormat utf16

UTF-16 characters (two byte code unit, up to 2 code units per character)

utf32

public static final QuanserStream.CharacterFormat utf32

UTF-32 characters (four byte code unit, always one code unit per character)

Method Details

values

public static QuanserStream.CharacterFormat[] 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 QuanserStream.CharacterFormat 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