Package org.apache.juneau.marshall.marshaller

Class Toml

java.lang.Object
org.apache.juneau.marshall.marshaller.Marshaller
org.apache.juneau.marshall.marshaller.CharMarshaller
org.apache.juneau.marshall.marshaller.Toml
Direct Known Subclasses:
TomlR
public class Toml extends CharMarshaller
TOML marshaller combining TomlSerializer and TomlParser.
Examples:

// Serialize a config map to TOML Map<String, Object> config = Map.of("name", "myapp", "port", 8080); String toml = Toml.of(config); // Parse TOML into JsonMap JsonMap parsed = Toml.to(toml, JsonMap.class); // Round-trip a bean MyConfig config = new MyConfig("myapp", 8080); toml = Toml.of(config); MyConfig restored = Toml.to(toml, MyConfig.class);

// Using instance methods Toml m = Toml.DEFAULT; String toml = m.write(config); JsonMap parsed = m.read(toml, JsonMap.class);

Example output (Map of name/age):

name = "Alice" age = 30

Complex (nested table + array):

name = "Alice" age = 30 tags = ["a", "b", "c"] [address] street = "123 Main St" city = "Boston" state = "MA"

// Using static shortcuts. MyPojo myPojo = Toml.to(string, MyPojo.class); String string = Toml.of(myPojo);

See Also:

  • Field Details

    • DEFAULT

      public static final Toml DEFAULT
      Default marshaller instance.

  • Constructor Details

    • Toml

      public Toml()
      Creates using default serializer and parser.

    • Toml

      public Toml(TomlSerializer s, TomlParser p)
      Creates with custom serializer and parser.
      Parameters:
      s - The serializer.
      p - The parser.

  • Method Details

    • of

      public static String of(Object object) throws SerializeException
      Serializes a POJO to a String using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.write(object).

      Parameters:
      object - The object to serialize.
      Returns:
      The serialized object.
      Throws:
      SerializeException - If a problem occurred trying to convert the output.

    • to

      public static <T> T to(String input, Class<T> type) throws ParseException
      Parses an input into the specified object type using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.read(input, type).

      Type Parameters:
      T - The class type of the object being created.
      Parameters:
      input - The input.
      type - The object type to create.
      Returns:
      The parsed object.
      Throws:
      ParseException - Malformed input encountered.

    • to

      public static <T> T to(String input, Type type, Type... args) throws ParseException
      Parses an input into the specified parameterized object type using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.read(input, type, args).

      Type Parameters:
      T - The class type of the object to create.
      Parameters:
      input - The input.
      type - The object type to create.
      args - The type arguments of the class if it's a collection or map.
      Returns:
      The parsed object.
      Throws:
      ParseException - Malformed input encountered.

    • to

      public static <T> T to(Reader input, Class<T> type) throws ParseException
      Parses the contents of a Reader into the specified object type using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.read(input, type) that catches any IOException from the underlying stream and rethrows it as an unchecked ParseException, so the caller is not burdened with a checked exception.

      Type Parameters:
      T - The class type of the object being created.
      Parameters:
      input - The input reader.
      type - The object type to create.
      Returns:
      The parsed object.
      Throws:
      ParseException - Malformed input encountered or an I/O error occurred on the underlying stream.

    • to

      public static <T> T to(Reader input, Type type, Type... args) throws ParseException
      Parses the contents of a Reader into the specified parameterized object type using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.read(input, type, args) that catches any IOException from the underlying stream and rethrows it as an unchecked ParseException, so the caller is not burdened with a checked exception.

      Type Parameters:
      T - The class type of the object to create.
      Parameters:
      input - The input reader.
      type - The object type to create.
      args - The type arguments of the class if it's a collection or map.
      Returns:
      The parsed object.
      Throws:
      ParseException - Malformed input encountered or an I/O error occurred on the underlying stream.

    • of

      public static void of(Object object, Writer output) throws SerializeException
      Serializes a POJO to the specified Writer using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.write(object, output) that catches any IOException from the underlying stream and rethrows it as an unchecked SerializeException, so the caller is not burdened with a checked exception.

      Parameters:
      object - The object to serialize.
      output - The writer to serialize to.
      Throws:
      SerializeException - If a problem occurred trying to convert the output or an I/O error occurred on the underlying stream.

    • toRecords

      public static RecordReader toRecords(Object input) throws IOException
      Opens a low-level RecordReader cursor over the specified input using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.readRecords(input).

      Parameters:
      input - The input.
      Returns:
      A new RecordReader.
      Throws:
      IOException - If a problem occurred opening the underlying input.

    • ofRecords

      public static RecordWriter ofRecords(Object output) throws IOException
      Opens a low-level RecordWriter cursor over the specified output using the DEFAULT marshaller.

      A shortcut for calling DEFAULT.writeRecords(output).

      Parameters:
      output - The output.
      Returns:
      A new RecordWriter.
      Throws:
      IOException - If a problem occurred opening the underlying output.