Class MapLikeType
- java.lang.Object
-
- com.fasterxml.jackson.core.type.ResolvedType
-
- com.fasterxml.jackson.databind.JavaType
-
- com.fasterxml.jackson.databind.type.TypeBase
-
- com.fasterxml.jackson.databind.type.MapLikeType
-
- All Implemented Interfaces:
JsonSerializable,Serializable,Type
- Direct Known Subclasses:
MapType
public class MapLikeType extends TypeBase
Type that represents Map-like types; things that consist of key/value pairs but that do not necessarily implementMap, but that do not have enough introspection functionality to allow for some level of generic handling. This specifically allows framework to check for configuration and annotation settings used for Map types, and pass these to custom handlers that may be more familiar with actual type.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
-
Field Summary
Fields Modifier and Type Field Description protected JavaType_keyTypeType of keys of Map.protected JavaType_valueTypeType of values of Map.-
Fields inherited from class com.fasterxml.jackson.databind.type.TypeBase
_bindings, _superClass, _superInterfaces
-
Fields inherited from class com.fasterxml.jackson.databind.JavaType
_asStatic, _class, _hash, _typeHandler, _valueHandler
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMapLikeType(TypeBase base, JavaType keyT, JavaType valueT)protectedMapLikeType(Class<?> mapType, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType keyT, JavaType valueT, Object valueHandler, Object typeHandler, boolean asStatic)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected JavaType_narrow(Class<?> subclass)Deprecated.protected StringbuildCanonicalName()static MapLikeTypeconstruct(Class<?> rawType, JavaType keyT, JavaType valueT)Deprecated.booleanequals(Object o)JavaTypegetContentType()ObjectgetContentTypeHandler()ObjectgetContentValueHandler()StringBuildergetErasedSignature(StringBuilder sb)Method for accessing signature without generic type information, in form compatible with all versions of JVM, and specifically used for type descriptions when generating byte code.StringBuildergetGenericSignature(StringBuilder sb)JavaTypegetKeyType()booleanhasHandlers()Helper method that checks whether this type, or its (optional) key or content type hasJavaType.getValueHandler()orJavaType.getTypeHandler(); that is, are there any non-standard handlers associated with this type object.booleanisContainerType()booleanisMapLikeType()booleanisTrueMapType()Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype ofCollectionor just something that acts like one.JavaTyperefine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)Mutant factory method that will try to create and return a sub-type instance for known parameterized types; for other types will return `null` to indicate that no just refinement makes necessary sense, without trying to detect special status through implemented interfaces.StringtoString()static MapLikeTypeupgradeFrom(JavaType baseType, JavaType keyT, JavaType valueT)Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifierJavaTypewithContentType(JavaType contentType)Mutant factory method that may be called on structured types that have a so-called content type (element of arrays, value type of Maps, referenced type of referential types), and will construct a new instance that is identical to this instance, except that it has specified content type, instead of current one.MapLikeTypewithContentTypeHandler(Object h)Mutant factory method that will construct a new instance that is identical to this instance, except that it will have specified content type (element type for arrays, value type for Maps and so forth) handler assigned.MapLikeTypewithContentValueHandler(Object h)Mutant factory method that will construct a new instance that is identical to this instance, except that it will have specified content value handler assigned.JavaTypewithHandlersFrom(JavaType src)Mutant factory method that will try to copy handlers that the specified source type instance had, if any; this must be done recursively where necessary (as content types may be structured).MapLikeTypewithKeyType(JavaType keyType)MapLikeTypewithKeyTypeHandler(Object h)MapLikeTypewithKeyValueHandler(Object h)MapLikeTypewithStaticTyping()Method that can be called to get a type instance that indicates that values of the type should be handled using "static typing" for purposes of serialization (as opposed to "dynamic" aka runtime typing): meaning that no runtime information is needed for determining serializers to use.MapLikeTypewithTypeHandler(Object h)"Copy method" that will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.MapLikeTypewithValueHandler(Object h)Mutant factory method that will construct a new instance that is identical to this instance, except that it will have specified value handler assigned.-
Methods inherited from class com.fasterxml.jackson.databind.type.TypeBase
_bogusSuperClass, _classSignature, containedType, containedTypeCount, containedTypeName, findSuperType, findTypeParameters, getBindings, getInterfaces, getSuperClass, serialize, serializeWithType, toCanonical
-
Methods inherited from class com.fasterxml.jackson.databind.JavaType
containedTypeOrUnknown, forcedNarrowBy, getErasedSignature, getGenericSignature, getParameterSource, getRawClass, getReferencedType, getTypeHandler, getValueHandler, hasContentType, hasGenericTypes, hashCode, hasRawClass, hasValueHandler, isAbstract, isArrayType, isCollectionLikeType, isConcrete, isEnumType, isFinal, isInterface, isJavaLangObject, isPrimitive, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.reflect.Type
getTypeName
-
-
-
-
Method Detail
-
upgradeFrom
public static MapLikeType upgradeFrom(JavaType baseType, JavaType keyT, JavaType valueT)
Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifier- Since:
- 2.7
-
construct
@Deprecated public static MapLikeType construct(Class<?> rawType, JavaType keyT, JavaType valueT)
Deprecated.
-
_narrow
@Deprecated protected JavaType _narrow(Class<?> subclass)
Deprecated.
-
withKeyType
public MapLikeType withKeyType(JavaType keyType)
- Since:
- 2.7
-
withContentType
public JavaType withContentType(JavaType contentType)
Description copied from class:JavaTypeMutant factory method that may be called on structured types that have a so-called content type (element of arrays, value type of Maps, referenced type of referential types), and will construct a new instance that is identical to this instance, except that it has specified content type, instead of current one. If content type is already set to given type,thisis returned. If type does not have a content type (which is the case withSimpleType),IllegalArgumentExceptionwill be thrown.- Specified by:
withContentTypein classJavaType- Returns:
- Newly created type instance
-
withTypeHandler
public MapLikeType withTypeHandler(Object h)
Description copied from class:JavaType"Copy method" that will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.- Specified by:
withTypeHandlerin classJavaType- Returns:
- Newly created type instance
-
withContentTypeHandler
public MapLikeType withContentTypeHandler(Object h)
Description copied from class:JavaTypeMutant factory method that will construct a new instance that is identical to this instance, except that it will have specified content type (element type for arrays, value type for Maps and so forth) handler assigned.- Specified by:
withContentTypeHandlerin classJavaType- Returns:
- Newly created type instance, with given
-
withValueHandler
public MapLikeType withValueHandler(Object h)
Description copied from class:JavaTypeMutant factory method that will construct a new instance that is identical to this instance, except that it will have specified value handler assigned.- Specified by:
withValueHandlerin classJavaType- Returns:
- Newly created type instance
-
withContentValueHandler
public MapLikeType withContentValueHandler(Object h)
Description copied from class:JavaTypeMutant factory method that will construct a new instance that is identical to this instance, except that it will have specified content value handler assigned.- Specified by:
withContentValueHandlerin classJavaType- Returns:
- Newly created type instance
-
withHandlersFrom
public JavaType withHandlersFrom(JavaType src)
Description copied from class:JavaTypeMutant factory method that will try to copy handlers that the specified source type instance had, if any; this must be done recursively where necessary (as content types may be structured).- Overrides:
withHandlersFromin classJavaType
-
withStaticTyping
public MapLikeType withStaticTyping()
Description copied from class:JavaTypeMethod that can be called to get a type instance that indicates that values of the type should be handled using "static typing" for purposes of serialization (as opposed to "dynamic" aka runtime typing): meaning that no runtime information is needed for determining serializers to use. The main use case is to allow forcing of specific root value serialization type, and specifically in resolving serializers for contained types (element types for arrays, Collections and Maps).- Specified by:
withStaticTypingin classJavaType
-
refine
public JavaType refine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)
Description copied from class:JavaTypeMutant factory method that will try to create and return a sub-type instance for known parameterized types; for other types will return `null` to indicate that no just refinement makes necessary sense, without trying to detect special status through implemented interfaces.
-
buildCanonicalName
protected String buildCanonicalName()
- Overrides:
buildCanonicalNamein classTypeBase
-
isContainerType
public boolean isContainerType()
- Specified by:
isContainerTypein classJavaType- Returns:
- True if type represented is a container type; this includes array, Map and Collection types.
-
isMapLikeType
public boolean isMapLikeType()
- Overrides:
isMapLikeTypein classJavaType- Returns:
- True if type is either true
Maptype, or something similar (meaning it has at least two type parameter; first one describing key type, second value type)
-
getKeyType
public JavaType getKeyType()
- Overrides:
getKeyTypein classJavaType
-
getContentType
public JavaType getContentType()
- Overrides:
getContentTypein classJavaType
-
getContentValueHandler
public Object getContentValueHandler()
- Overrides:
getContentValueHandlerin classJavaType
-
getContentTypeHandler
public Object getContentTypeHandler()
- Overrides:
getContentTypeHandlerin classJavaType
-
hasHandlers
public boolean hasHandlers()
Description copied from class:JavaTypeHelper method that checks whether this type, or its (optional) key or content type hasJavaType.getValueHandler()orJavaType.getTypeHandler(); that is, are there any non-standard handlers associated with this type object.- Overrides:
hasHandlersin classJavaType
-
getErasedSignature
public StringBuilder getErasedSignature(StringBuilder sb)
Description copied from class:JavaTypeMethod for accessing signature without generic type information, in form compatible with all versions of JVM, and specifically used for type descriptions when generating byte code.- Specified by:
getErasedSignaturein classTypeBase- Parameters:
sb- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
getGenericSignature
public StringBuilder getGenericSignature(StringBuilder sb)
- Specified by:
getGenericSignaturein classTypeBase- Parameters:
sb- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
withKeyTypeHandler
public MapLikeType withKeyTypeHandler(Object h)
-
withKeyValueHandler
public MapLikeType withKeyValueHandler(Object h)
-
isTrueMapType
public boolean isTrueMapType()
Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype ofCollectionor just something that acts like one.
-
-