package com.fasterxml.jackson.jr.ob.api;
import com.fasterxml.jackson.core.TreeCodec;
API that lets JacksonJrExtension
s to register handlers it needs to. Since: 2.11
/**
* API that lets {@link com.fasterxml.jackson.jr.ob.JacksonJrExtension}s to register handlers
* it needs to.
*
* @since 2.11
*/
public abstract class ExtensionContext
{
// // // Override of (and access to) singleton handlers
Method for setting TreeCodec
to use, replacing codec that was formerly configured (if any). Params: - tc – (optional) Tree Codec to use, or
null
for removing currently configured one
Returns: This context, to allow call chaining
/**
* Method for setting {@link TreeCodec} to use, replacing codec that was formerly configured
* (if any).
*
* @param tc (optional) Tree Codec to use, or {@code null} for removing currently configured one
*
* @return This context, to allow call chaining
*/
public abstract ExtensionContext setTreeCodec(TreeCodec tc);
Returns: TreeCodec currently configured to be used, if any (null
if none).
/**
* @return TreeCodec currently configured to be used, if any ({@code null} if none).
*/
public abstract TreeCodec treeCodec();
// // // Addition of chainable handlers
Method for inserting specified ReaderWriterProvider
as the highest priority provider (that is, having higher precedence than anything registered so far) Params: - provider – Provider to register
Returns: This context, to allow call chaining
/**
* Method for inserting specified {@link ReaderWriterProvider} as the highest priority
* provider (that is, having higher precedence than anything registered so far)
*
* @param provider Provider to register
*
* @return This context, to allow call chaining
*/
public abstract ExtensionContext insertProvider(ReaderWriterProvider provider);
Method for inserting specified ReaderWriterProvider
as the lowest priority provider (that is, having lower precedence than anything registered so far) Params: - provider – Provider to register
Returns: This context, to allow call chaining
/**
* Method for inserting specified {@link ReaderWriterProvider} as the lowest priority
* provider (that is, having lower precedence than anything registered so far)
*
* @param provider Provider to register
*
* @return This context, to allow call chaining
*/
public abstract ExtensionContext appendProvider(ReaderWriterProvider provider);
Method for inserting specified ReaderWriterModifier
as the highest priority modifier (that is, being called before any other modifiers registered). Params: - modifier – Modifier to register
Returns: This context, to allow call chaining
/**
* Method for inserting specified {@link ReaderWriterModifier} as the highest priority
* modifier (that is, being called before any other modifiers registered).
*
* @param modifier Modifier to register
*
* @return This context, to allow call chaining
*/
public abstract ExtensionContext insertModifier(ReaderWriterModifier modifier);
Method for inserting specified ReaderWriterModifier
as the lowest priority modifier (that is, being called after all other modifiers registered). Params: - modifier – Modifier to register
Returns: This context, to allow call chaining
/**
* Method for inserting specified {@link ReaderWriterModifier} as the lowest priority
* modifier (that is, being called after all other modifiers registered).
*
* @param modifier Modifier to register
*
* @return This context, to allow call chaining
*/
public abstract ExtensionContext appendModifier(ReaderWriterModifier modifier);
}