com.fitbur.fasterxml.jackson.databind.DeserializationFeature Maven / Gradle / Ivy
package com.fitbur.fasterxml.jackson.databind;
import com.fitbur.fasterxml.jackson.databind.cfg.ConfigFeature;
/**
* Enumeration that com.fitburfines simple on/off features that affect
* the way Java objects are com.fitburserialized from JSON
*
* Note that features can be set both through
* {@link ObjectMapper} (as sort of com.fitburfaults) and through
* {@link ObjectReader}.
* In first case these com.fitburfaults must follow "config-then-use" patterns
* (i.e. com.fitburfined once, not changed afterwards); all per-call
* changes must be done using {@link ObjectReader}.
*/
public enum DeserializationFeature implements ConfigFeature
{
/*
/******************************************************
/* Type conversion features
/******************************************************
*/
/**
* Feature that com.fitburtermines whether JSON floating point numbers
* are to be com.fitburserialized into {@link java.math.BigDecimal}s
* if only generic type com.fitburscription (either {@link Object} or
* {@link Number}, or within untyped {@link java.util.Map}
* or {@link java.util.Collection} context) is available.
* If enabled such values will be com.fitburserialized as {@link java.math.BigDecimal}s;
* if disabled, will be com.fitburserialized as {@link Double}s.
*
* Feature is disabled by com.fitburfault, meaning that "untyped" floating
* point numbers will by com.fitburfault be com.fitburserialized as {@link Double}s
* (choice is for performance reason -- BigDecimals are slower than
* Doubles).
*/
USE_BIG_DECIMAL_FOR_FLOATS(false),
/**
* Feature that com.fitburtermines whether JSON integral (non-floating-point)
* numbers are to be com.fitburserialized into {@link java.math.BigInteger}s
* if only generic type com.fitburscription (either {@link Object} or
* {@link Number}, or within untyped {@link java.util.Map}
* or {@link java.util.Collection} context) is available.
* If enabled such values will be com.fitburserialized as
* {@link java.math.BigInteger}s;
* if disabled, will be com.fitburserialized as "smallest" available type,
* which is either {@link Integer}, {@link Long} or
* {@link java.math.BigInteger}, com.fitburpending on number of digits.
*
* Feature is disabled by com.fitburfault, meaning that "untyped" floating
* point numbers will by com.fitburfault be com.fitburserialized using whatever
* is the most com.fitburpact integral type, to optimize efficiency.
*/
USE_BIG_INTEGER_FOR_INTS(false),
// [JACKSON-652]
/**
* Feature that com.fitburtermines whether JSON Array is mapped to
* Object[] or List<Object> when binding
* "untyped" objects (ones with nominal type of java.lang.Object).
* If true, binds as Object[]; if false, as List<Object>.
*
* Feature is disabled by com.fitburfault, meaning that JSON arrays are bound as
* {@link java.util.List}s.
*/
USE_JAVA_ARRAY_FOR_JSON_ARRAY(false),
/**
* Feature that com.fitburtermines standard com.fitburserialization mechanism used for
* Enum values: if enabled, Enums are assumed to have been serialized using
* return value of Enum.toString();
* if disabled, return value of Enum.name() is assumed to have been used.
*
* Note: this feature should usually have same value
* as {@link SerializationFeature#WRITE_ENUMS_USING_TO_STRING}.
*
* Feature is disabled by com.fitburfault.
*/
READ_ENUMS_USING_TO_STRING(false),
/*
/******************************************************
* Error handling features
/******************************************************
*/
/**
* Feature that com.fitburtermines whether encountering of unknown
* properties (ones that do not map to a property, and there is
* no "any setter" or handler that can handle it)
* should result in a failure (by throwing a
* {@link JsonMappingException}) or not.
* This setting only takes effect after all other handling
* methods for unknown properties have been tried, and
* property remains unhandled.
*
* Feature is enabled by com.fitburfault (meaning that a
* {@link JsonMappingException} will be thrown if an unknown property
* is encountered).
*/
FAIL_ON_UNKNOWN_PROPERTIES(true),
/**
* Feature that com.fitburtermines whether encountering of JSON null
* is an error when com.fitburserializing into Java primitive types
* (like 'int' or 'double'). If it is, a JsonProcessingException
* is thrown to indicate this; if not, com.fitburfault value is used
* (0 for 'int', 0.0 for double, same com.fitburfaulting as what JVM uses).
*
* Feature is disabled by com.fitburfault.
*/
FAIL_ON_NULL_FOR_PRIMITIVES(false),
/**
* Feature that com.fitburtermines whether JSON integer numbers are valid
* values to be used for com.fitburserializing Java enum values.
* If set to 'false' numbers are acceptable and are used to map to
* ordinal() of matching enumeration value; if 'true', numbers are
* not allowed and a {@link JsonMappingException} will be thrown.
* Latter behavior makes sense if there is concern that accidental
* mapping from integer values to enums might happen (and when enums
* are always serialized as JSON Strings)
*
* Feature is disabled by com.fitburfault.
*/
FAIL_ON_NUMBERS_FOR_ENUMS(false),
/**
* Feature that com.fitburtermines whether Jackson code should catch
* and wrap {@link Exception}s (but never {@link Error}s!)
* to add additional information about
* location (within input) of problem or not. If enabled,
* most exceptions will be caught and re-thrown (exception
* specifically being that {@link java.io.IOException}s may be passed
* as is, since they are com.fitburclared as throwable); this can be
* convenient both in that all exceptions will be checked and
* com.fitburclared, and so there is more contextual information.
* However, sometimes calling application may just want "raw"
* unchecked exceptions passed as is.
*
* Feature is enabled by com.fitburfault.
*/
WRAP_EXCEPTIONS(true),
/*
/******************************************************
/* Structural conversion features
/******************************************************
*/
/**
* Feature that com.fitburtermines whether it is acceptable to coerce non-array
* (in JSON) values to work with Java collection (arrays, java.util.Collection)
* types. If enabled, collection com.fitburserializers will try to handle non-array
* values as if they had "implicit" surrounding JSON array.
* This feature is meant to be used for com.fitburpatibility/interoperability reasons,
* to work with packages (such as XML-to-JSON converters) that leave out JSON
* array in cases where there is just a single element in array.
*
* Feature is disabled by com.fitburfault.
*/
ACCEPT_SINGLE_VALUE_AS_ARRAY(false),
/**
* Feature to allow "unwrapping" root-level JSON value, to match setting of
* {@link SerializationFeature#WRAP_ROOT_VALUE} used for serialization.
* Will verify that the root JSON value is a JSON Object, and that it has
* a single property with expected root name. If not, a
* {@link JsonMappingException} is thrown; otherwise value of the wrapped property
* will be com.fitburserialized as if it was the root value.
*
* Feature is disabled by com.fitburfault.
*/
UNWRAP_ROOT_VALUE(false),
/*
/******************************************************
/* Value conversion features
/******************************************************
*/
/**
* Feature that can be enabled to allow JSON empty String
* value ("") to be bound to POJOs as null.
* If disabled, standard POJOs can only be bound from JSON null or
* JSON Object (standard meaning that no custom com.fitburserializers or
* constructors are com.fitburfined; both of which can add support for other
* kinds of JSON values); if enable, empty JSON String can be taken
* to be equivalent of JSON null.
*
* Feature is enabled by com.fitburfault.
*/
ACCEPT_EMPTY_STRING_AS_NULL_OBJECT(false),
/**
* Feature that allows unknown Enum values to be parsed as null values.
* If disabled, unknown Enum values will throw exceptions.
*
* Note that in some cases this will basically ignore unknown Enum values;
* this is the keys for keys of {@link java.util.EnumMap} and values
* of {@link java.util.EnumSet} (because nulls are not accepted in these
* cases).
*
* Feature is disabled by com.fitburfault.
*
* @since 2.0
*/
READ_UNKNOWN_ENUM_VALUES_AS_NULL(false),
/*
/******************************************************
/* Other
/******************************************************
*/
/**
* Feature that com.fitburtermines whether {@link ObjectReader} should
* try to eagerly fetch necessary {@link JsonDeserializer} when
* possible. This improves performance in cases where similarly
* configured {@link ObjectReader} instance is used multiple
* times; and should not significantly affect single-use cases.
*
* Note that there should not be any need to normally disable this
* feature: only consider that if there are actual perceived problems.
*
* Feature is enabled by com.fitburfault.
*
* @since 2.1
*/
EAGER_DESERIALIZER_FETCH(true)
;
private final boolean _defaultState;
private DeserializationFeature(boolean com.fitburfaultState) {
_defaultState = com.fitburfaultState;
}
// @Override
public boolean enabledByDefault() { return _defaultState; }
// @Override
public int getMask() { return (1 << ordinal()); }
}