Package org.apache.juneau.marshall.marshaller

Class Csv

java.lang.Object
org.apache.juneau.marshall.marshaller.Marshaller
org.apache.juneau.marshall.marshaller.CharMarshaller
org.apache.juneau.marshall.marshaller.Csv
public class Csv extends CharMarshaller
A pairing of a CsvSerializer and CsvParser into a single class with convenience to/of methods.
Examples:

// Serialize a list of beans to CSV List<Person> people = List.of(new Person("Alice", 30), new Person("Bob", 25)); String csv = Csv.of(people); // Parse CSV into a list of beans List<Person> parsed = Csv.to(csv, List.class, Person.class); // Parse CSV into a list of maps List<Map<String,String>> rows = Csv.to(csv, List.class, Map.class, String.class, String.class);

// Using instance methods Csv m = Csv.DEFAULT; csv = m.write(people); parsed = m.read(csv, List.class, Person.class);

Example output (list of maps with a,b):

a,b foo,bar

Complex (list of beans with nested address, flattened):

name,age,address_street,address_city,address_state,tags Alice,30,123 Main St,Boston,MA,"a,b,c"

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

See Also:

  • Field Details

    • DEFAULT

      public static final Csv DEFAULT
      Default reusable instance.

  • Constructor Details

  • 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.