zserio.runtime.json

Enum JsonWriter.EnumerableFormat

java.lang.Object

java.lang.Enum<JsonWriter.EnumerableFormat>

zserio.runtime.json.JsonWriter.EnumerableFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JsonWriter.EnumerableFormat>

Enclosing class:

JsonWriter

public static enum JsonWriter.EnumerableFormat
extends java.lang.Enum<JsonWriter.EnumerableFormat>

Configuration for writing of enumerable types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NUMBER Print as JSON integral value.
STRING Print as JSON string according to the following rules: Enums when an exact match with an enumerable item is found, the item name is used - e.g.

Method Summary

Modifier and Type	Method and Description
static JsonWriter.EnumerableFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JsonWriter.EnumerableFormat[]	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

NUMBER

public static final JsonWriter.EnumerableFormat NUMBER

Print as JSON integral value.

STRING

public static final JsonWriter.EnumerableFormat STRING

Print as JSON string according to the following rules:

1. Enums
   • when an exact match with an enumerable item is found, the item name is used - e.g. "FIRST",
   • when no exact match is found, it's an invalid value, the integral value is converted to string and an appropriate comment is included - e.g. "10 /* no match */".
2. Bitmasks
   • when an exact mach with or-ed bitmask values is found, it's used - e.g. "READ | WRITE",
   • when no exact match is found, but some or-ed values match, the integral value is converted to string and the or-ed values are included in a comment - e.g. "127 /* READ | CREATE */",
   • when no match is found at all, the integral value is converted to string and an appropriate comment is included - e.g. "13 /* no match */".

Method Detail

values

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

Returns:

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

valueOf

public static JsonWriter.EnumerableFormat 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