Package com.zeroc.Ice

Enum Class ToStringMode

java.lang.Object

java.lang.Enum<ToStringMode>

com.zeroc.Ice.ToStringMode

All Implemented Interfaces:

Serializable, Comparable<ToStringMode>, Constable

public enum ToStringMode
extends Enum<ToStringMode>

The output mode for xxxToString method such as identityToString and proxyToString. The actual encoding format for the string is the same for all modes: you don't need to specify an encoding format or mode when reading such a string.

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
ASCII	Characters with ordinal values greater than 127 are encoded as universal character names in the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters.
Compat	Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using octal escapes.
Unicode	Characters with ordinal values greater than 127 are kept as-is in the resulting string.

Method Summary

Modifier and Type	Method	Description
int	value()
static ToStringMode	valueOf(int v)	Returns the enum constant of this class with the specified name.
static ToStringMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ToStringMode[]	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

Unicode

public static final ToStringMode Unicode

Characters with ordinal values greater than 127 are kept as-is in the resulting string. Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or \\unnnn.

ASCII

public static final ToStringMode ASCII

Characters with ordinal values greater than 127 are encoded as universal character names in the resulting string: \\unnnn for BMP characters and \\Unnnnnnnn for non-BMP characters. Non-printable ASCII characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or \\unnnn.

Compat

public static final ToStringMode Compat

Characters with ordinal values greater than 127 are encoded as a sequence of UTF-8 bytes using octal escapes. Characters with ordinal values 127 and below are encoded as \\t, \\n (etc.) or an octal escape. Use this mode to generate strings compatible with Ice 3.6 and earlier.

Method Details

values

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

value

public int value()

valueOf

public static ToStringMode valueOf(int v)

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:

v - 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