Package org.apache.juneau.marshall.sse

Class SseParser

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.parser.Parser

org.apache.juneau.marshall.parser.ReaderParser

org.apache.juneau.marshall.sse.SseParser

All Implemented Interfaces:

RecordReadable

public class SseParser
extends ReaderParser
implements RecordReadable

Parses text/event-stream input (WHATWG Server-Sent Events) into Java objects.

Media types

Handles Content-Type types: text/event-stream.

Description

Eager parse path — drains the stream into a List<SseEvent>. For true line-driven streaming over long-lived connections, use SseEventReader directly.

Notes:

• This class is thread safe and reusable.

See Also:

• SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SseParser.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.ReaderParser

ReaderParser.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final SseParser	DEFAULT	Default parser, all default settings.

Fields inherited from class org.apache.juneau.marshall.parser.Parser

autoCloseStreams, consumes, debugOutputLines, listener, nulls, trimStrings, unbuffered

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
SseParser(SseParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
SseParser.Builder	copy()	Creates a builder from this context object.
static SseParser.Builder	create()	Creates a new builder for this object.
SseParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
SseParserSession	getSession()	Returns a session to use for this context.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordReader	readRecords(Object input)	Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser

getStreamCharset, isReaderParser, properties

Methods inherited from class org.apache.juneau.marshall.parser.Parser

canHandle, createParserBuilder, doRead, getDebugOutputLines, getListener, getMediaTypes, getNulls, getPrimaryMediaType, isAutoCloseStreams, isTrimStrings, isUnbuffered, read, read, read, read, read, read, readArgs, readIntoCollection, readIntoMap, readWithOuter

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat

Methods inherited from class org.apache.juneau.marshall.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final SseParser DEFAULT

Default parser, all default settings.

Constructor Details

SseParser

public SseParser(SseParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static SseParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public SseParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Parser

Returns:

A new Builder object.

createSession

public SseParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class ReaderParser

Returns:

A new session builder.

getSession

public SseParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class ReaderParser

Returns:

A new session object.

readRecords

public RecordReader readRecords(Object input)
                         throws IOException

Convenience delegator that opens a RecordReader over the input using default session arguments (mirrors Parser.read(Object, Class)).

The real implementation lives on SseParserSession.readRecords(Object). Callers that need request-derived configuration (locale, timezone, schema, swaps) should call createSession() and invoke SseParserSession.readRecords(Object) on the built session instead.

Specified by:

readRecords in interface RecordReadable

Parameters:

input - The input.

Returns:

A new RecordReader cursor.

Throws:

IOException - If a problem occurred opening the underlying input.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordReadable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordReadable

Returns:

true if RecordReadable.readRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.