Package org.tomlj

Enum JsonOptions

java.lang.Object
java.lang.Enum<JsonOptions>
org.tomlj.JsonOptions
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<JsonOptions>, java.lang.constant.Constable
public enum JsonOptions
extends java.lang.Enum<JsonOptions>
Options for serializing TOML to JSON.

These options are suitable for use with `toJson` methods, e.g. TomlTable.toJson(JsonOptions...), TomlArray.toJson(JsonOptions...).

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ALL_VALUES_AS_STRINGS
    Output all values as strings, rather than using integer, float or boolean values.
    VALUES_AS_OBJECTS_WITH_TYPE
    Output values as objects including a "type" and "value" property.

  • Method Summary

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

    • VALUES_AS_OBJECTS_WITH_TYPE

      public static final JsonOptions VALUES_AS_OBJECTS_WITH_TYPE
      Output values as objects including a "type" and "value" property. E.g.:

      { "type": "string", "value": "hello world" }

    • ALL_VALUES_AS_STRINGS

      public static final JsonOptions ALL_VALUES_AS_STRINGS
      Output all values as strings, rather than using integer, float or boolean values.

  • Method Details

    • values

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