edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializationConfig Maven / Gradle / Ivy
Show all versions of grouperClient Show documentation
package edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind;
import java.text.DateFormat;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.annotation.*;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.*;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.json.JsonWriteFeature;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.util.Instantiatable;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.*;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.SimpleMixInResolver;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.jsontype.SubtypeResolver;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.FilterProvider;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.SerializerFactory;
import edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.util.RootNameLookup;
/**
* Object that contains baseline configuration for serialization
* process. An instance is owned by {@link ObjectMapper}, which
* passes an immutable instance for serialization process to
* {@link SerializerProvider} and {@link SerializerFactory}
* (either directly, or through {@link ObjectWriter}.
*
* Note that instances are considered immutable and as such no copies
* should need to be created for sharing; all copying is done with
* "fluent factory" methods.
*/
public final class SerializationConfig
extends MapperConfigBase
implements java.io.Serializable // since 2.1
{
// since 2.5
private static final long serialVersionUID = 1;
// since 2.6
protected final static PrettyPrinter DEFAULT_PRETTY_PRINTER = new DefaultPrettyPrinter();
// since 2.10.1
private final static int SER_FEATURE_DEFAULTS = collectFeatureDefaults(SerializationFeature.class);
/*
/**********************************************************
/* Configured helper objects
/**********************************************************
*/
/**
* Object used for resolving filter ids to filter instances.
* Non-null if explicitly defined; null by default.
*/
protected final FilterProvider _filterProvider;
/**
* If "default pretty-printing" is enabled, it will create the instance
* from this blueprint object.
*
* @since 2.6
*/
protected final PrettyPrinter _defaultPrettyPrinter;
/*
/**********************************************************
/* Serialization features
/**********************************************************
*/
/**
* Set of {@link SerializationFeature}s enabled.
*/
protected final int _serFeatures;
/*
/**********************************************************
/* Generator features: generic, format-specific
/**********************************************************
*/
/**
* States of {@link edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator.Feature}s to enable/disable.
*/
protected final int _generatorFeatures;
/**
* Bitflag of {@link edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator.Feature}s to enable/disable
*/
protected final int _generatorFeaturesToChange;
/**
* States of {@link edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.FormatFeature}s to enable/disable.
*
* @since 2.7
*/
protected final int _formatWriteFeatures;
/**
* Bitflag of {@link edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.FormatFeature}s to enable/disable
*
* @since 2.7
*/
protected final int _formatWriteFeaturesToChange;
/*
/**********************************************************
/* Life-cycle, primary constructors for new instances
/**********************************************************
*/
/**
* Constructor used by ObjectMapper to create default configuration object instance.
*
* @since 2.14
*/
public SerializationConfig(BaseSettings base,
SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames,
ConfigOverrides configOverrides,
DatatypeFeatures datatypeFeatures)
{
super(base, str, mixins, rootNames, configOverrides, datatypeFeatures);
_serFeatures = SER_FEATURE_DEFAULTS;
_filterProvider = null;
_defaultPrettyPrinter = DEFAULT_PRETTY_PRINTER;
_generatorFeatures = 0;
_generatorFeaturesToChange = 0;
_formatWriteFeatures = 0;
_formatWriteFeaturesToChange = 0;
}
/**
* @deprecated since 2.14
*/
@Deprecated // since 2.14
public SerializationConfig(BaseSettings base,
SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames,
ConfigOverrides configOverrides)
{
this(base, str, mixins, rootNames, configOverrides,
DatatypeFeatures.defaultFeatures());
}
/**
* Copy-constructor used for making a copy to be used by new {@link ObjectMapper}.
*
* @since 2.14
*/
protected SerializationConfig(SerializationConfig src,
SubtypeResolver str, SimpleMixInResolver mixins, RootNameLookup rootNames,
ConfigOverrides configOverrides)
{
super(src, str, mixins, rootNames, configOverrides);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/*
/**********************************************************
/* Life-cycle, secondary constructors to support
/* "mutant factories", with single property changes
/**********************************************************
*/
private SerializationConfig(SerializationConfig src, SubtypeResolver str)
{
super(src, str);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
private SerializationConfig(SerializationConfig src,
long mapperFeatures, int serFeatures,
int generatorFeatures, int generatorFeatureMask,
int formatFeatures, int formatFeaturesMask)
{
super(src, mapperFeatures);
_serFeatures = serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = generatorFeatures;
_generatorFeaturesToChange = generatorFeatureMask;
_formatWriteFeatures = formatFeatures;
_formatWriteFeaturesToChange = formatFeaturesMask;
}
private SerializationConfig(SerializationConfig src, BaseSettings base)
{
super(src, base);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
private SerializationConfig(SerializationConfig src, FilterProvider filters)
{
super(src);
_serFeatures = src._serFeatures;
_filterProvider = filters;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
private SerializationConfig(SerializationConfig src, Class view)
{
super(src, view);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
private SerializationConfig(SerializationConfig src, PropertyName rootName)
{
super(src, rootName);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/**
* @since 2.1
*/
protected SerializationConfig(SerializationConfig src, ContextAttributes attrs)
{
super(src, attrs);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/**
* @since 2.1
*/
protected SerializationConfig(SerializationConfig src, SimpleMixInResolver mixins)
{
super(src, mixins);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/**
* @since 2.6
*/
protected SerializationConfig(SerializationConfig src, PrettyPrinter defaultPP)
{
super(src);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = defaultPP;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/**
* @since 2.14
*/
protected SerializationConfig(SerializationConfig src, DatatypeFeatures dtFeatures)
{
super(src, dtFeatures);
_serFeatures = src._serFeatures;
_filterProvider = src._filterProvider;
_defaultPrettyPrinter = src._defaultPrettyPrinter;
_generatorFeatures = src._generatorFeatures;
_generatorFeaturesToChange = src._generatorFeaturesToChange;
_formatWriteFeatures = src._formatWriteFeatures;
_formatWriteFeaturesToChange = src._formatWriteFeaturesToChange;
}
/*
/**********************************************************
/* Life-cycle, factory methods from MapperConfig(Base)
/**********************************************************
*/
@Override
protected final SerializationConfig _withBase(BaseSettings newBase) {
return (_base == newBase) ? this : new SerializationConfig(this, newBase);
}
@Override
protected final SerializationConfig _withMapperFeatures(long mapperFeatures) {
return new SerializationConfig(this, mapperFeatures, _serFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
@Override
protected final SerializationConfig _with(DatatypeFeatures dtFeatures) {
return new SerializationConfig(this, dtFeatures);
}
@Override
public SerializationConfig withRootName(PropertyName rootName) {
if (rootName == null) {
if (_rootName == null) {
return this;
}
} else if (rootName.equals(_rootName)) {
return this;
}
return new SerializationConfig(this, rootName);
}
@Override
public SerializationConfig with(SubtypeResolver str) {
return (str == _subtypeResolver)? this : new SerializationConfig(this, str);
}
@Override
public SerializationConfig withView(Class view) {
return (_view == view) ? this : new SerializationConfig(this, view);
}
@Override
public SerializationConfig with(ContextAttributes attrs) {
return (attrs == _attributes) ? this : new SerializationConfig(this, attrs);
}
/*
/**********************************************************
/* Factory method overrides
/**********************************************************
*/
/**
* In addition to constructing instance with specified date format,
* will enable or disable SerializationFeature.WRITE_DATES_AS_TIMESTAMPS
* (enable if format set as null; disable if non-null)
*/
@Override
public SerializationConfig with(DateFormat df) {
SerializationConfig cfg = super.with(df);
// Also need to toggle this feature based on existence of date format:
if (df == null) {
return cfg.with(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
}
return cfg.without(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
}
/*
/**********************************************************
/* Factory methods for SerializationFeature
/**********************************************************
*/
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature enabled.
*/
public SerializationConfig with(SerializationFeature feature)
{
int newSerFeatures = _serFeatures | feature.getMask();
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features enabled.
*/
public SerializationConfig with(SerializationFeature first, SerializationFeature... features)
{
int newSerFeatures = _serFeatures | first.getMask();
for (SerializationFeature f : features) {
newSerFeatures |= f.getMask();
}
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features enabled.
*/
public SerializationConfig withFeatures(SerializationFeature... features)
{
int newSerFeatures = _serFeatures;
for (SerializationFeature f : features) {
newSerFeatures |= f.getMask();
}
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature disabled.
*/
public SerializationConfig without(SerializationFeature feature)
{
int newSerFeatures = _serFeatures & ~feature.getMask();
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features disabled.
*/
public SerializationConfig without(SerializationFeature first, SerializationFeature... features)
{
int newSerFeatures = _serFeatures & ~first.getMask();
for (SerializationFeature f : features) {
newSerFeatures &= ~f.getMask();
}
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features disabled.
*/
public SerializationConfig withoutFeatures(SerializationFeature... features)
{
int newSerFeatures = _serFeatures;
for (SerializationFeature f : features) {
newSerFeatures &= ~f.getMask();
}
return (newSerFeatures == _serFeatures) ? this
: new SerializationConfig(this, _mapperFeatures, newSerFeatures,
_generatorFeatures, _generatorFeaturesToChange,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/*
/**********************************************************
/* Factory methods for JsonGenerator.Feature (2.5)
/**********************************************************
*/
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature enabled.
*
* @since 2.5
*/
public SerializationConfig with(JsonGenerator.Feature feature)
{
int newSet = _generatorFeatures | feature.getMask();
int newMask = _generatorFeaturesToChange | feature.getMask();
return ((_generatorFeatures == newSet) && (_generatorFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
newSet, newMask,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features enabled.
*
* @since 2.5
*/
public SerializationConfig withFeatures(JsonGenerator.Feature... features)
{
int newSet = _generatorFeatures;
int newMask = _generatorFeaturesToChange;
for (JsonGenerator.Feature f : features) {
int mask = f.getMask();
newSet |= mask;
newMask |= mask;
}
return ((_generatorFeatures == newSet) && (_generatorFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
newSet, newMask,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature disabled.
*
* @since 2.5
*/
public SerializationConfig without(JsonGenerator.Feature feature)
{
int newSet = _generatorFeatures & ~feature.getMask();
int newMask = _generatorFeaturesToChange | feature.getMask();
return ((_generatorFeatures == newSet) && (_generatorFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
newSet, newMask,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features disabled.
*
* @since 2.5
*/
public SerializationConfig withoutFeatures(JsonGenerator.Feature... features)
{
int newSet = _generatorFeatures;
int newMask = _generatorFeaturesToChange;
for (JsonGenerator.Feature f : features) {
int mask = f.getMask();
newSet &= ~mask;
newMask |= mask;
}
return ((_generatorFeatures == newSet) && (_generatorFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
newSet, newMask,
_formatWriteFeatures, _formatWriteFeaturesToChange);
}
/*
/**********************************************************
/* Factory methods for FormatFeature (2.7)
/**********************************************************
*/
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature enabled.
*
* @since 2.7
*/
public SerializationConfig with(FormatFeature feature)
{
// 27-Oct-2018, tatu: Alas, complexity due to newly (2.10) refactored json-features:
if (feature instanceof JsonWriteFeature) {
return _withJsonWriteFeatures(feature);
}
int newSet = _formatWriteFeatures | feature.getMask();
int newMask = _formatWriteFeaturesToChange | feature.getMask();
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
_generatorFeatures, _generatorFeaturesToChange,
newSet, newMask);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features enabled.
*
* @since 2.7
*/
public SerializationConfig withFeatures(FormatFeature... features)
{
// 27-Oct-2018, tatu: Alas, complexity due to newly (2.10) refactored json-features:
if (features.length > 0 && (features[0] instanceof JsonWriteFeature)) {
return _withJsonWriteFeatures(features);
}
int newSet = _formatWriteFeatures;
int newMask = _formatWriteFeaturesToChange;
for (FormatFeature f : features) {
int mask = f.getMask();
newSet |= mask;
newMask |= mask;
}
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
_generatorFeatures, _generatorFeaturesToChange,
newSet, newMask);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified feature disabled.
*
* @since 2.7
*/
public SerializationConfig without(FormatFeature feature)
{
// 27-Oct-2018, tatu: Alas, complexity due to newly (2.10) refactored json-features:
if (feature instanceof JsonWriteFeature) {
return _withoutJsonWriteFeatures(feature);
}
int newSet = _formatWriteFeatures & ~feature.getMask();
int newMask = _formatWriteFeaturesToChange | feature.getMask();
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
_generatorFeatures, _generatorFeaturesToChange,
newSet, newMask);
}
/**
* Fluent factory method that will construct and return a new configuration
* object instance with specified features disabled.
*
* @since 2.7
*/
public SerializationConfig withoutFeatures(FormatFeature... features)
{
if (features.length > 0 && (features[0] instanceof JsonWriteFeature)) {
return _withoutJsonWriteFeatures(features);
}
int newSet = _formatWriteFeatures;
int newMask = _formatWriteFeaturesToChange;
for (FormatFeature f : features) {
int mask = f.getMask();
newSet &= ~mask;
newMask |= mask;
}
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
_generatorFeatures, _generatorFeaturesToChange,
newSet, newMask);
}
// temporary for 2.10
private SerializationConfig _withJsonWriteFeatures(FormatFeature... features) {
int parserSet = _generatorFeatures;
int parserMask = _generatorFeaturesToChange;
int newSet = _formatWriteFeatures;
int newMask = _formatWriteFeaturesToChange;
for (FormatFeature f : features) {
final int mask = f.getMask();
newSet |= mask;
newMask |= mask;
if (f instanceof JsonWriteFeature) {
JsonGenerator.Feature oldF = ((JsonWriteFeature) f).mappedFeature();
if (oldF != null) {
final int pmask = oldF.getMask();
parserSet |= pmask;
parserMask |= pmask;
}
}
}
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)
&& (_generatorFeatures == parserSet) && (_generatorFeaturesToChange == parserMask)
) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
parserSet, parserMask, newSet, newMask);
}
// temporary for 2.10
private SerializationConfig _withoutJsonWriteFeatures(FormatFeature... features) {
int parserSet = _generatorFeatures;
int parserMask = _generatorFeaturesToChange;
int newSet = _formatWriteFeatures;
int newMask = _formatWriteFeaturesToChange;
for (FormatFeature f : features) {
final int mask = f.getMask();
newSet &= ~mask;
newMask |= mask;
if (f instanceof JsonWriteFeature) {
JsonGenerator.Feature oldF = ((JsonWriteFeature) f).mappedFeature();
if (oldF != null) {
final int pmask = oldF.getMask();
parserSet &= ~pmask;
parserMask |= pmask;
}
}
}
return ((_formatWriteFeatures == newSet) && (_formatWriteFeaturesToChange == newMask)
&& (_generatorFeatures == parserSet) && (_generatorFeaturesToChange == parserMask)
) ? this :
new SerializationConfig(this, _mapperFeatures, _serFeatures,
parserSet, parserMask, newSet, newMask);
}
/*
/**********************************************************
/* Factory methods, other
/**********************************************************
*/
public SerializationConfig withFilters(FilterProvider filterProvider) {
return (filterProvider == _filterProvider) ? this : new SerializationConfig(this, filterProvider);
}
/**
* Mutant factory method for constructing a new instance with different
* default inclusion criteria configuration.
*
* @since 2.7
*
* @deprecated Since 2.9; not needed any more
*/
@Deprecated
public SerializationConfig withPropertyInclusion(JsonInclude.Value incl) {
_configOverrides.setDefaultInclusion(incl);
return this;
}
/**
* @since 2.6
*/
public SerializationConfig withDefaultPrettyPrinter(PrettyPrinter pp) {
return (_defaultPrettyPrinter == pp) ? this: new SerializationConfig(this, pp);
}
/*
/**********************************************************
/* Factories for objects configured here
/**********************************************************
*/
public PrettyPrinter constructDefaultPrettyPrinter() {
PrettyPrinter pp = _defaultPrettyPrinter;
if (pp instanceof Instantiatable) {
pp = (PrettyPrinter) ((Instantiatable) pp).createInstance();
}
return pp;
}
/*
/**********************************************************
/* JsonParser initialization
/**********************************************************
*/
/**
* Method called by {@link ObjectMapper} and {@link ObjectWriter}
* to modify those {@link edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.core.JsonGenerator.Feature} settings
* that have been configured via this config instance.
*
* @since 2.5
*/
public void initialize(JsonGenerator g)
{
if (SerializationFeature.INDENT_OUTPUT.enabledIn(_serFeatures)) {
// but do not override an explicitly set one
if (g.getPrettyPrinter() == null) {
PrettyPrinter pp = constructDefaultPrettyPrinter();
if (pp != null) {
g.setPrettyPrinter(pp);
}
}
}
@SuppressWarnings("deprecation")
boolean useBigDec = SerializationFeature.WRITE_BIGDECIMAL_AS_PLAIN.enabledIn(_serFeatures);
int mask = _generatorFeaturesToChange;
if ((mask != 0) || useBigDec) {
int newFlags = _generatorFeatures;
// although deprecated, needs to be supported for now
if (useBigDec) {
int f = JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN.getMask();
newFlags |= f;
mask |= f;
}
g.overrideStdFeatures(newFlags, mask);
}
if (_formatWriteFeaturesToChange != 0) {
g.overrideFormatFeatures(_formatWriteFeatures, _formatWriteFeaturesToChange);
}
}
/*
/**********************************************************
/* Configuration: default settings with per-type overrides
/**********************************************************
*/
/**
* @deprecated Since 2.7 use {@link #getDefaultPropertyInclusion} instead
*/
@Deprecated
public JsonInclude.Include getSerializationInclusion()
{
JsonInclude.Include incl = getDefaultPropertyInclusion().getValueInclusion();
return (incl == JsonInclude.Include.USE_DEFAULTS) ? JsonInclude.Include.ALWAYS : incl;
}
/*
/**********************************************************
/* Configuration: other
/**********************************************************
*/
@Override
public boolean useRootWrapping()
{
if (_rootName != null) { // empty String disables wrapping; non-empty enables
return !_rootName.isEmpty();
}
return isEnabled(SerializationFeature.WRAP_ROOT_VALUE);
}
/**
* Accessor for checking whether give {@link SerializationFeature}
* is enabled or not.
*
* @param feature Feature to check
*
* @return True if feature is enabled; false otherwise
*/
public final boolean isEnabled(SerializationFeature feature) {
return (_serFeatures & feature.getMask()) != 0;
}
/**
* Accessor method that first checks if we have any overrides
* for feature, and only if not, checks state of passed-in
* factory.
*
* @since 2.5
*/
public final boolean isEnabled(JsonGenerator.Feature f, JsonFactory factory) {
int mask = f.getMask();
if ((_generatorFeaturesToChange & mask) != 0) {
return (_generatorFeatures & f.getMask()) != 0;
}
return factory.isEnabled(f);
}
/**
* "Bulk" access method for checking that all features specified by
* mask are enabled.
*
* @since 2.3
*/
public final boolean hasSerializationFeatures(int featureMask) {
return (_serFeatures & featureMask) == featureMask;
}
public final int getSerializationFeatures() {
return _serFeatures;
}
/**
* Accessor for checking whether give {@link DatatypeFeature}
* is enabled or not.
*
* @param feature Feature to check
*
* @return True if feature is enabled; false otherwise
*
* @since 2.14
*/
public final boolean isEnabled(DatatypeFeature feature) {
return _datatypeFeatures.isEnabled(feature);
}
/**
* Method for getting provider used for locating filters given
* id (which is usually provided with filter annotations).
* Will be null if no provided was set for {@link ObjectWriter}
* (or if serialization directly called from {@link ObjectMapper})
*/
public FilterProvider getFilterProvider() {
return _filterProvider;
}
/**
* Accessor for configured blueprint "default" {@link PrettyPrinter} to
* use, if default pretty-printing is enabled.
*
* NOTE: returns the "blueprint" instance, and does NOT construct
* an instance ready to use; call {@link #constructDefaultPrettyPrinter()} if
* actually usable instance is desired.
*
* @since 2.6
*/
public PrettyPrinter getDefaultPrettyPrinter() {
return _defaultPrettyPrinter;
}
/*
/**********************************************************
/* Introspection methods
/**********************************************************
*/
/**
* Method that will introspect full bean properties for the purpose
* of building a bean serializer
*/
public BeanDescription introspect(JavaType type) {
return getClassIntrospector().forSerialization(this, type, this);
}
}