Package org.apache.juneau.marshall

Class MarshallingTraverseContext

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

Direct Known Subclasses:

JsonSchemaGenerator, Serializer

public abstract class MarshallingTraverseContext
extends MarshallingContextable

Parent class for all classes that traverse POJOs.

Description

Base class that serves as the parent class for all serializers and other classes that traverse POJOs.

Notes:

• This class is thread safe and reusable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarshallingTraverseContext.Builder<SELF extends MarshallingTraverseContext.Builder<SELF>>	Builder class.

Field Summary

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

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

Method Summary

Modifier and Type	Method	Description
abstract MarshallingTraverseContext.Builder<?>	copy()	Creates a builder from this context object.
protected final boolean	getDetectRecursions()	Detect recursions flag (raw value).
protected final boolean	getIgnoreRecursions()	Ignore recursions flag (raw value).
final int	getInitialDepth()	Initial depth.
final int	getMaxDepth()	Max traversal depth.
final boolean	isDetectRecursions()	Automatically detect POJO recursions.
final boolean	isIgnoreRecursions()	Ignore recursion errors.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
protected final boolean	shouldDetectRecursions()	Whether recursion detection is effectively enabled during traversal.

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

getDurationFormat, getMarshallingContext, getPeriodFormat

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

createBuilder, createSession, getAnnotationProvider, getSession, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

MarshallingTraverseContext

protected MarshallingTraverseContext(MarshallingTraverseContext.Builder builder)

Constructor

Parameters:

builder - The builder for this object. Cannot be null.

Method Details

copy

public abstract MarshallingTraverseContext.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 Context

Returns:

A new Builder object.

getInitialDepth

public final int getInitialDepth()

Initial depth.

Returns:

The initial indentation level at the root.

See Also:

• MarshallingTraverseContext.Builder.initialDepth(int)

getMaxDepth

public final int getMaxDepth()

Max traversal depth.

Returns:

The depth beyond which nodes in the POJO tree are dropped (truncated) from the output.
Values deeper than this limit are silently omitted rather than causing an exception to be thrown.
This is a size guard, not a cycle detector.

See Also:

• MarshallingTraverseContext.Builder.maxDepth(int)

isDetectRecursions

public final boolean isDetectRecursions()

Automatically detect POJO recursions.

Returns:

true if recursions should be checked for during traversal.

See Also:

• MarshallingTraverseContext.Builder.detectRecursions()

shouldDetectRecursions

protected final boolean shouldDetectRecursions()

Whether recursion detection is effectively enabled during traversal. This is isDetectRecursions() OR isIgnoreRecursions() OR Context.isDebug().

isIgnoreRecursions

public final boolean isIgnoreRecursions()

Ignore recursion errors.

Returns:

true if when we encounter the same object when traversing a tree, we set the value to null.
Otherwise, an exception is thrown with the message "Recursion occurred, stack=...".

See Also:

• MarshallingTraverseContext.Builder.ignoreRecursions()

getDetectRecursions

protected final boolean getDetectRecursions()

Detect recursions flag (raw value).

Returns:

The detect recursions flag.

getIgnoreRecursions

protected final boolean getIgnoreRecursions()

Ignore recursions flag (raw value).

Returns:

The ignore recursions flag.

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class MarshallingContextable

Returns:

The properties on this bean as a map for debugging.