Package org.apache.juneau.marshall

Class ContextSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

Direct Known Subclasses:

MarshallingSession, RestOpSession, RestSession

public abstract class ContextSession
extends Object

A one-time-use non-thread-safe object that's meant to be used once and then thrown away.

Notes:

• This class is not typically thread safe.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContextSession(ContextSession.Builder<?> builder)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	addWarning(String msg, Object... args)	Logs a warning message.
void	checkForWarnings()	Throws a BeanRuntimeException if any warnings occurred in this session and debug is enabled.
Context	getContext()	Returns the context that created this session.
final Map<String,Object>	getSessionProperties()	Returns the session properties on this session.
final List<String>	getWarnings()	Returns the warnings that occurred in this session.
boolean	isDebug()	Debug mode enabled.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ContextSession

protected ContextSession(ContextSession.Builder<?> builder)

Default constructor.

Parameters:

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

Method Details

addWarning

public void addWarning(String msg,
 Object... args)

Logs a warning message.

Parameters:

msg - The warning message.
Cannot be null.

args - Optional String.format-style arguments.
Cannot be null (individual values may be null).

checkForWarnings

public void checkForWarnings()

Throws a BeanRuntimeException if any warnings occurred in this session and debug is enabled.

getContext

public Context getContext()

Returns the context that created this session.

Returns:

The context that created this session.

getSessionProperties

public final Map<String,Object> getSessionProperties()

Returns the session properties on this session.

Returns:

The session properties on this session. Never null.

getWarnings

public final List<String> getWarnings()

Returns the warnings that occurred in this session.

Returns:

The warnings that occurred in this session, or an empty list if no warnings occurred.

isDebug

public boolean isDebug()

Debug mode enabled.

Returns:

true if debug mode is enabled.

See Also:

• Context.Builder.debug()

toString

public String toString()

Overrides:

toString in class Object

properties

protected FluentMap<String,Object> properties()

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

Returns:

The properties on this bean as a map for debugging.