Package org.apache.juneau.marshall.jsonl

Class JsonlSerializerSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.serializer.SerializerSession

org.apache.juneau.marshall.serializer.WriterSerializerSession

org.apache.juneau.marshall.json.JsonSerializerSession

org.apache.juneau.marshall.jsonl.JsonlSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

Direct Known Subclasses:

Json5lSerializerSession

public class JsonlSerializerSession
extends JsonSerializerSession

Session object that lives for the duration of a single use of JsonlSerializer.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• JSONL

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.marshall.json.JsonSerializerSession

JsonSerializerSession.DefaultBuilder

Field Summary

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

indent

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

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonlSerializerSession(JsonlSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static JsonlSerializerSession.Builder	create(JsonlSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
RecordWriter	writeArrayRecords(Object output)	Streaming array-element RecordWriter for JSONL.
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits JSONL one structural event at a time, with a trailing newline after every top-level value, bound to this live session.

Methods inherited from class org.apache.juneau.marshall.json.JsonSerializerSession

create, getJsonClassMeta, getJsonWriter, isAddBeanTypes, isEscapeSolidus, isSimpleAttrs, writeAnything, writeBeanMap, writeJson, writeMap

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializerSession

create, createPipe, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, properties, write, writeToString

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession

addVarBean, canIgnoreValue, canIgnoreValue, create, createBeanTypeNameProperty, createDefaultVarResolverSession, forEachEntry, forEachEntry, forEachStreamableEntry, generalize, getBeanTypeName, getCalendarFormat, getDateFormat, getDurationFormat, getExpectedRootType, getJavaMethod, getListener, getListener, getLocaleFormat, getPeriodFormat, getResponseHeaders, getSchema, getTemporalFormat, getTimeZoneFormat, getUriContext, getUriRelativity, getUriResolution, getUriResolver, getVarResolver, handleThrown, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, onBeanGetterException, onError, push2, relativizeUri, resolve, resolveUri, sort, sort, sort, swap, toList, toListFromStreamable, toString, trim, unwrapSupplier, write, writeCalendar, writeDate, writeDuration, writePeriod, writeTemporal

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

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, pop, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

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

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

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

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.marshall.stream.ArrayRecordWritable

isArrayRecordStreaming, writeArrayRecords

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Methods inherited from interface org.apache.juneau.marshall.stream.RecordWritable

isRecordStreaming

Methods inherited from interface org.apache.juneau.marshall.stream.TokenWritable

writeRecords

Constructor Details

JsonlSerializerSession

protected JsonlSerializerSession(JsonlSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonlSerializerSession.Builder create(JsonlSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Opens a low-level push generator that emits JSONL one structural event at a time, with a trailing newline after every top-level value, bound to this live session.

Same honored/ignored builder properties as JsonSerializerSession.writeTokens(Object) except that useWhitespace is forced to false — pretty-printed JSONL is not standard.

Specified by:

writeTokens in interface TokenWritable

Overrides:

writeTokens in class JsonSerializerSession

Parameters:

output - The output.

Returns:

A new JsonlTokenWriter.

Throws:

IOException - If the output type is not supported or could not be opened.

writeArrayRecords

public RecordWriter writeArrayRecords(Object output)
                               throws IOException

Streaming array-element RecordWriter for JSONL.

Unlike the inherited JsonSerializerSession.writeArrayRecords(Object) — which wraps the writes in a bracketed top-level [...] array and is invalid for line-delimited JSONL — this aliases the JSONL line record stream: the JsonlTokenWriter returned by writeTokens(Object) is itself a RecordWriter whose write(...) emits one top-level value per line (no surrounding brackets). Memory is O(1) in the number of records.

Specified by:

writeArrayRecords in interface ArrayRecordWritable

Overrides:

writeArrayRecords in class JsonSerializerSession

Parameters:

output - The output.

Returns:

A new line-delimited RecordWriter.

Throws:

IOException - If a problem occurred opening the underlying output.

doWrite

protected void doWrite(SerializerPipe out,
 Object o)
                throws IOException,
SerializeException

Description copied from class: SerializerSession

Serializes a POJO to the specified pipe.

This method should NOT close the context object.

The default implementation of this method simply calls Serializer.doWrite(SerializerSession,SerializerPipe,Object).

Overrides:

doWrite in class JsonSerializerSession

Parameters:

out - Where to send the output from the serializer.

o - The object to serialize.

Throws:

IOException - Thrown by underlying stream.

SerializeException - Problem occurred trying to serialize object.