Package org.apache.juneau.marshall.marshaller

Class Sse

java.lang.Object
org.apache.juneau.marshall.marshaller.Marshaller
org.apache.juneau.marshall.marshaller.CharMarshaller
org.apache.juneau.marshall.marshaller.Sse
public class Sse extends CharMarshaller
Pairs SseSerializer and SseParser into a single class with convenience read/write methods for the text/event-stream wire format.
Examples:

// Serialize a list of events using the DEFAULT instance List<SseEvent> events = List.of( new SseEvent("progress", "step 1"), new SseEvent("progress", "step 2") ); String wire = Sse.of(events); // Parse a wire string back into a list of events List<SseEvent> parsed = Sse.to(wire, List.class, SseEvent.class);

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

See Also:

  • Field Details

    • DEFAULT

      public static final Sse DEFAULT
      Default reusable instance.

  • Constructor Details

    • Sse

      public Sse()
      Constructor.

    • Sse

      public Sse(SseSerializer s, SseParser p)
      Constructor.
      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.