Package org.apache.juneau.marshall.jcs

Class JcsSerializerSession

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.jcs.JcsSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

public class JcsSerializerSession
extends JsonSerializerSession

Session object for JcsSerializer that produces RFC 8785 canonical JSON.

See Also:

• RFC 8785 — JSON Canonicalization Scheme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JcsSerializerSession.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	JcsSerializerSession(JcsSerializerSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static JcsSerializerSession.Builder	create(JcsSerializer ctx)	Creates a new builder for this object.
protected JsonWriter<?>	getJsonWriter(SerializerPipe out)	Converts the specified output target object to an JsonWriter.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
static int	jcsCompare(String a, String b)	JCS key comparison: UTF-16 code unit ordering per RFC 8785.
static String	toEcmaNumber(Number n)	Converts a number to ECMAScript-compatible JSON string per RFC 8785.
protected SerializerWriter<?>	writeBeanMap(JsonWriter<?> out, BeanMap<?> m, String typeName)
protected SerializerWriter<?>	writeMap(JsonWriter<?> out, Map m, ClassMeta<?> type)
RecordWriter	writeRecords(Object output)	Returns a record writer that emits canonical JCS for each value passed to write(...) (delegates to this session's SerializerSession.write(Object, Object)).
TokenWriter	writeTokens(Object output)	Opens a low-level push generator that emits raw JSON (NOT canonical JCS) one structural event at a time, with the TokenWriter.object(Object) POJO bridge disabled (the walker would emit ordinary JSON, not canonical JCS).

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

create, doWrite, getJsonClassMeta, isAddBeanTypes, isEscapeSolidus, isSimpleAttrs, writeAnything, writeArrayRecords, writeJson

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

Constructor Details

JcsSerializerSession

protected JcsSerializerSession(JcsSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JcsSerializerSession.Builder create(JcsSerializer ctx)

Creates a new builder for this object.

Parameters:

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

Returns:

A new builder.

toEcmaNumber

public static String toEcmaNumber(Number n)

Converts a number to ECMAScript-compatible JSON string per RFC 8785.

Parameters:

n - The number.
Must not be null.

Returns:

The serialized string.

Throws:

SerializeException - If the number is NaN or Infinity.

jcsCompare

public static int jcsCompare(String a,
 String b)

JCS key comparison: UTF-16 code unit ordering per RFC 8785.

Null keys (e.g., from HashMap with null key) sort before non-null.

Parameters:

a - First string.

b - Second string.

Returns:

Comparison result (negative, zero, or positive).

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Opens a low-level push generator that emits raw JSON (NOT canonical JCS) one structural event at a time, with the TokenWriter.object(Object) POJO bridge disabled (the walker would emit ordinary JSON, not canonical JCS). Use writeRecords(Object) or SerializerSession.write(Object, Object) for canonical output.

Specified by:

writeTokens in interface TokenWritable

Overrides:

writeTokens in class JsonSerializerSession

Parameters:

output - The output.

Returns:

A new JsonTokenWriter with object(...) disabled.

Throws:

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

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Returns a record writer that emits canonical JCS for each value passed to write(...) (delegates to this session's SerializerSession.write(Object, Object)).

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

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

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordWritable

Streaming-quality signal queryable before opening a cursor.

Returns:

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

getJsonWriter

protected JsonWriter<?> getJsonWriter(SerializerPipe out)

Description copied from class: JsonSerializerSession

Converts the specified output target object to an JsonWriter.

Overrides:

getJsonWriter in class JsonSerializerSession

Parameters:

out - The output target object.
Must not be null.

Returns:

The output target object wrapped in an JsonWriter.

writeMap

protected SerializerWriter<?> writeMap(JsonWriter<?> out,
 Map m,
 ClassMeta<?> type)
                                throws SerializeException

Overrides:

writeMap in class JsonSerializerSession

Throws:

SerializeException

writeBeanMap

protected SerializerWriter<?> writeBeanMap(JsonWriter<?> out,
 BeanMap<?> m,
 String typeName)
                                    throws SerializeException

Overrides:

writeBeanMap in class JsonSerializerSession

Throws:

SerializeException