Package org.apache.juneau.marshall.json

Class JsonSchemaSerializerSession

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.json.JsonSchemaSerializerSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordWritable, RecordWritable, TokenWritable

public class JsonSchemaSerializerSession
extends JsonSerializerSession

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

Notes:

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

See Also:

• JSON

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JsonSchemaSerializerSession.Builder	create(JsonSchemaSerializer ctx)	Creates a new builder for this object.
protected void	doWrite(SerializerPipe out, Object o)	Serializes a POJO to the specified pipe.
protected JsonSchemaBeanPropertyMeta	getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
protected JsonSchemaClassMeta	getJsonSchemaClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
RecordWriter	writeRecords(Object output)	Returns a record writer that emits the JSON Schema 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 schema) one structural event at a time, with the TokenWriter.object(Object) POJO bridge disabled (the walker would emit the bean's own JSON, not its JSON Schema).

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

create, getJsonClassMeta, getJsonWriter, isAddBeanTypes, isEscapeSolidus, isSimpleAttrs, writeAnything, writeArrayRecords, 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

Constructor Details

JsonSchemaSerializerSession

protected JsonSchemaSerializerSession(JsonSchemaSerializerSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonSchemaSerializerSession.Builder create(JsonSchemaSerializer ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

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.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Opens a low-level push generator that emits raw JSON (NOT schema) one structural event at a time, with the TokenWriter.object(Object) POJO bridge disabled (the walker would emit the bean's own JSON, not its JSON Schema). Use writeRecords(Object) or SerializerSession.write(Object, Object) for schema generation.

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 the JSON Schema 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.

getJsonSchemaBeanPropertyMeta

protected JsonSchemaBeanPropertyMeta getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)

Returns the language-specific metadata on the specified bean property.

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getJsonSchemaClassMeta

protected JsonSchemaClassMeta getJsonSchemaClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.