com.fasterxml.jackson.databind.cfg

Class MapperConfigBase<CFG extends ConfigFeature,T extends MapperConfigBase<CFG,T>>

    • Field Detail

      • EMPTY_OVERRIDE

        protected static final ConfigOverride EMPTY_OVERRIDE
        Since:
        2.9
      • _mixIns

        protected final SimpleMixInResolver _mixIns
        Mix-in annotation mappings to use, if any: immutable, cannot be changed once defined.
        Since:
        2.6
      • _subtypeResolver

        protected final SubtypeResolver _subtypeResolver
        Registered concrete subtypes that can be used instead of (or in addition to) ones declared using annotations.

        Note that instances are stateful and as such may need to be copied, and may NOT be demoted down to BaseSettings.

      • _rootName

        protected final PropertyName _rootName
        Explicitly defined root name to use, if any; if empty String, will disable root-name wrapping; if null, will use defaults
      • _view

        protected final Class<?> _view
        View to use for filtering out properties to serialize or deserialize. Null if none (will also be assigned null if Object.class is defined), meaning that all properties are to be included.
      • _attributes

        protected final ContextAttributes _attributes
        Contextual attributes accessible (get and set) during processing, on per-call basis.
        Since:
        2.3
      • _rootNames

        protected final RootNameLookup _rootNames
        Simple cache used for finding out possible root name for root name wrapping.

        Note that instances are stateful (for caching) and as such may need to be copied, and may NOT be demoted down to BaseSettings.

        Since:
        2.6
      • _configOverrides

        protected final ConfigOverrides _configOverrides
        Configuration overrides to apply, keyed by type of property.
        Since:
        2.8
    • Method Detail

      • _withBase

        protected abstract T _withBase(BaseSettings newBase)
        Since:
        2.9 (in this case, demoted from sub-classes)
      • _withMapperFeatures

        protected abstract T _withMapperFeatures(int mapperFeatures)
        Since:
        2.9 (in this case, demoted from sub-classes)
      • with

        public final T with(MapperFeature... features)
        Fluent factory method that will construct and return a new configuration object instance with specified features enabled.
        Specified by:
        with in class MapperConfig<T extends MapperConfigBase<CFG,T>>
      • with

        public final T with(AnnotationIntrospector ai)
        Method for constructing and returning a new instance with different AnnotationIntrospector to use (replacing old one).

        NOTE: make sure to register new instance with ObjectMapper if directly calling this method.

      • withAppendedAnnotationIntrospector

        public final T withAppendedAnnotationIntrospector(AnnotationIntrospector ai)
        Method for constructing and returning a new instance with additional AnnotationIntrospector appended (as the lowest priority one)
      • withInsertedAnnotationIntrospector

        public final T withInsertedAnnotationIntrospector(AnnotationIntrospector ai)
        Method for constructing and returning a new instance with additional AnnotationIntrospector inserted (as the highest priority one)
      • with

        public final T with(ClassIntrospector ci)
        Method for constructing and returning a new instance with different ClassIntrospector to use.

        NOTE: make sure to register new instance with ObjectMapper if directly calling this method.

      • with

        public abstract T with(ContextAttributes attrs)
        Method for constructing an instance that has specified contextual attributes.
        Since:
        2.3
      • withAttributes

        public T withAttributes(Map<?,?> attributes)
        Method for constructing an instance that has only specified attributes, removing any attributes that exist before the call.
        Since:
        2.3
      • withAttribute

        public T withAttribute(Object key,
                               Object value)
        Method for constructing an instance that has specified value for attribute for given key.
        Since:
        2.3
      • withoutAttribute

        public T withoutAttribute(Object key)
        Method for constructing an instance that has no value for attribute for given key.
        Since:
        2.3
      • with

        public final T with(TypeFactory tf)
        Method for constructing and returning a new instance with different TypeFactory to use.
      • with

        public final T with(PropertyNamingStrategy pns)
        Method for constructing and returning a new instance with different PropertyNamingStrategy to use.

        NOTE: make sure to register new instance with ObjectMapper if directly calling this method.

      • with

        public final T with(HandlerInstantiator hi)
        Method for constructing and returning a new instance with different HandlerInstantiator to use.

        NOTE: make sure to register new instance with ObjectMapper if directly calling this method.

      • with

        public final T with(com.fasterxml.jackson.core.Base64Variant base64)
        Method for constructing and returning a new instance with different default Base64Variant to use with base64-encoded binary values.
      • with

        public T with(DateFormat df)
        Method for constructing and returning a new instance with different DateFormat to use.

        NOTE: non-final since SerializationConfig needs to override this

      • with

        public final T with(Locale l)
        Method for constructing and returning a new instance with different default Locale to use for formatting.
      • with

        public final T with(TimeZone tz)
        Method for constructing and returning a new instance with different default TimeZone to use for formatting of date values.
      • withRootName

        public abstract T withRootName(PropertyName rootName)
        Method for constructing and returning a new instance with different root name to use (none, if null).

        Note that when a root name is set to a non-Empty String, this will automatically force use of root element wrapping with given name. If empty String passed, will disable root name wrapping; and if null used, will instead use SerializationFeature to determine if to use wrapping, and annotation (or default name) for actual root name to use.

        Parameters:
        rootName - to use: if null, means "use default" (clear setting); if empty String ("") means that no root name wrapping is used; otherwise defines root name to use.
        Since:
        2.6
      • withRootName

        public T withRootName(String rootName)
      • with

        public abstract T with(SubtypeResolver str)
        Method for constructing and returning a new instance with different SubtypeResolver to use.

        NOTE: make sure to register new instance with ObjectMapper if directly calling this method.

      • withView

        public abstract T withView(Class<?> view)
        Method for constructing and returning a new instance with different view to use.
      • getFullRootName

        public final PropertyName getFullRootName()
        Since:
        2.6
      • getConfigOverride

        public final ConfigOverride getConfigOverride(Class<?> type)
        Description copied from class: MapperConfig
        Accessor for finding ConfigOverride to use for properties of given type, if any exist; or if none, return an immutable "empty" instance with no overrides.

        Note that only directly associated override is found; no type hierarchy traversal is performed.

        Specified by:
        getConfigOverride in class MapperConfig<T extends MapperConfigBase<CFG,T>>
        Returns:
        Override object to use for the type, never null (but may be empty)
      • findConfigOverride

        public final ConfigOverride findConfigOverride(Class<?> type)
        Description copied from class: MapperConfig
        Accessor for finding ConfigOverride to use for properties of given type, if any exist; or return `null` if not.

        Note that only directly associated override is found; no type hierarchy traversal is performed.

        Specified by:
        findConfigOverride in class MapperConfig<T extends MapperConfigBase<CFG,T>>
        Returns:
        Override object to use for the type, if defined; null if none.
      • getDefaultPropertyInclusion

        public final com.fasterxml.jackson.annotation.JsonInclude.Value getDefaultPropertyInclusion()
        Description copied from class: MapperConfig
        Accessor for default property inclusion to use for serialization, used unless overridden by per-type or per-property overrides.
        Specified by:
        getDefaultPropertyInclusion in class MapperConfig<T extends MapperConfigBase<CFG,T>>
      • getDefaultInclusion

        public final com.fasterxml.jackson.annotation.JsonInclude.Value getDefaultInclusion(Class<?> baseType,
                                                                                            Class<?> propertyType)
        Description copied from class: MapperConfig
        Accessor for default property inclusion to use for serialization, considering possible per-type override for given base type and possible per-type override for given property type.
        NOTE: if no override found, defaults to value returned by MapperConfig.getDefaultPropertyInclusion().
        Specified by:
        getDefaultInclusion in class MapperConfig<T extends MapperConfigBase<CFG,T>>
        Parameters:
        baseType - Type of the instance containing the targeted property.
        propertyType - Type of the property to look up inclusion setting for.
      • getDefaultPropertyFormat

        public final com.fasterxml.jackson.annotation.JsonFormat.Value getDefaultPropertyFormat(Class<?> type)
        Description copied from class: MapperConfig
        Accessor for default format settings to use for serialization (and, to a degree deserialization), considering baseline settings and per-type defaults for given base type (if any).
        Specified by:
        getDefaultPropertyFormat in class MapperConfig<T extends MapperConfigBase<CFG,T>>
      • getDefaultPropertyIgnorals

        public final com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value getDefaultPropertyIgnorals(Class<?> baseType,
                                                                                                            AnnotatedClass actualClass)
        Description copied from class: MapperConfig
        Helper method that may be called to see if there are property ignoral definitions from annotations (via AnnotatedClass) or through "config overrides". If both exist, config overrides have precedence over class annotations.
        Specified by:
        getDefaultPropertyIgnorals in class MapperConfig<T extends MapperConfigBase<CFG,T>>
      • getDefaultVisibilityChecker

        public final VisibilityChecker<?> getDefaultVisibilityChecker()
        Description copied from class: MapperConfig
        Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers). Can be changed to allow different minimum visibility levels for auto-detection. Note that this is the global handler; individual types (classes) can further override active checker used (using JsonAutoDetect annotation)
        Specified by:
        getDefaultVisibilityChecker in class MapperConfig<T extends MapperConfigBase<CFG,T>>
      • getDefaultSetterInfo

        public final com.fasterxml.jackson.annotation.JsonSetter.Value getDefaultSetterInfo()
        Description copied from class: MapperConfig
        Accessor for the baseline setter info used as the global baseline, not considering possible per-type overrides.
        Specified by:
        getDefaultSetterInfo in class MapperConfig<T extends MapperConfigBase<CFG,T>>
        Returns:
        Global base settings; never null
      • getDefaultMergeable

        public Boolean getDefaultMergeable()
        Description copied from class: MapperConfig
        Accessor for the baseline merge info used as the global baseline, not considering possible per-type overrides.
        Specified by:
        getDefaultMergeable in class MapperConfig<T extends MapperConfigBase<CFG,T>>
        Returns:
        Global base settings, if any; `null` if none.
      • mixInCount

        public final int mixInCount()
        Test-only method -- does not reflect possibly open-ended set that external mix-in resolver might provide.

Copyright © 2008–2019 FasterXML. All rights reserved.