Class CollectionLikeType
- 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.CollectionLikeType
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
,java.lang.reflect.Type
- Direct Known Subclasses:
CollectionType
public class CollectionLikeType extends TypeBase
Type that represents things that act similar toCollection
; but may or may not be instances of that interface. 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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static CollectionLikeType
construct(java.lang.Class<?> rawType, JavaType elemT)
Deprecated.Since 2.7, useupgradeFrom(com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.JavaType)
for constructing instances, given pre-resolvedSimpleType
.static CollectionLikeType
construct(java.lang.Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType elemT)
boolean
equals(java.lang.Object o)
JavaType
getContentType()
Method for accessing content type of this type, if type has such a thing: simple types do not, structured types do (like arrays, Collections and Maps)java.lang.Object
getContentTypeHandler()
Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.java.lang.Object
getContentValueHandler()
Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.java.lang.StringBuilder
getErasedSignature(java.lang.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.java.lang.StringBuilder
getGenericSignature(java.lang.StringBuilder sb)
boolean
hasHandlers()
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.boolean
isCollectionLikeType()
boolean
isContainerType()
boolean
isTrueCollectionType()
Deprecated.Since 2.12 just use instanceofJavaType
refine(java.lang.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.java.lang.String
toString()
static CollectionLikeType
upgradeFrom(JavaType baseType, JavaType elementType)
Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifier
JavaType
withContentType(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.CollectionLikeType
withContentTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionLikeType
withContentValueHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.JavaType
withHandlersFrom(JavaType src)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionLikeType
withStaticTyping()
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.CollectionLikeType
withTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionLikeType
withValueHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.-
Methods inherited from class com.fasterxml.jackson.databind.type.TypeBase
containedType, containedTypeCount, containedTypeName, findSuperType, findTypeParameters, getBindings, getInterfaces, getSuperClass, serialize, serializeWithType, toCanonical
-
Methods inherited from class com.fasterxml.jackson.databind.JavaType
containedTypeOrUnknown, forcedNarrowBy, getErasedSignature, getGenericSignature, getKeyType, getParameterSource, getRawClass, getReferencedType, getTypeHandler, getValueHandler, hasContentType, hasGenericTypes, hashCode, hasRawClass, hasValueHandler, isAbstract, isArrayType, isConcrete, isEnumImplType, isEnumType, isFinal, isInterface, isJavaLangObject, isMapLikeType, isPrimitive, isRecordType, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType
-
Methods inherited from class com.fasterxml.jackson.core.type.ResolvedType
isReferenceType
-
-
-
-
Method Detail
-
construct
public static CollectionLikeType construct(java.lang.Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType elemT)
- Since:
- 2.7
-
construct
@Deprecated public static CollectionLikeType construct(java.lang.Class<?> rawType, JavaType elemT)
Deprecated.Since 2.7, useupgradeFrom(com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.JavaType)
for constructing instances, given pre-resolvedSimpleType
.
-
upgradeFrom
public static CollectionLikeType upgradeFrom(JavaType baseType, JavaType elementType)
Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifier
- Since:
- 2.7
-
withContentType
public JavaType withContentType(JavaType contentType)
Description copied from class:JavaType
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. If content type is already set to given type,this
is returned. If type does not have a content type (which is the case withSimpleType
),IllegalArgumentException
will be thrown.- Specified by:
withContentType
in classJavaType
- Returns:
- Newly created type instance
-
withTypeHandler
public CollectionLikeType withTypeHandler(java.lang.Object h)
Description copied from class:JavaType
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.This mutant factory method will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.
- Specified by:
withTypeHandler
in classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentTypeHandler
public CollectionLikeType withContentTypeHandler(java.lang.Object h)
Description copied from class:JavaType
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.This mutant factory method 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:
withContentTypeHandler
in classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withValueHandler
public CollectionLikeType withValueHandler(java.lang.Object h)
Description copied from class:JavaType
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.This mutant factory method will construct a new instance that is identical to this instance, except that it will have specified value handler assigned.
- Specified by:
withValueHandler
in classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentValueHandler
public CollectionLikeType withContentValueHandler(java.lang.Object h)
Description copied from class:JavaType
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.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.
- Specified by:
withContentValueHandler
in classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withHandlersFrom
public JavaType withHandlersFrom(JavaType src)
Description copied from class:JavaType
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.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).
- Overrides:
withHandlersFrom
in classJavaType
-
withStaticTyping
public CollectionLikeType withStaticTyping()
Description copied from class:JavaType
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. 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:
withStaticTyping
in classJavaType
-
refine
public JavaType refine(java.lang.Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)
Description copied from class:JavaType
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.
-
isContainerType
public boolean isContainerType()
- Specified by:
isContainerType
in classJavaType
- Returns:
- True if type represented is a container type; this includes array, Map and Collection types.
-
isCollectionLikeType
public boolean isCollectionLikeType()
- Overrides:
isCollectionLikeType
in classJavaType
- Returns:
- True if type is either true
Collection
type, or something similar (meaning it has at least one type parameter, which describes type of contents)
-
getContentType
public JavaType getContentType()
Description copied from class:ResolvedType
Method for accessing content type of this type, if type has such a thing: simple types do not, structured types do (like arrays, Collections and Maps)- Overrides:
getContentType
in classJavaType
- Returns:
- Content type of this type, if any;
null
if none
-
getContentValueHandler
public java.lang.Object getContentValueHandler()
Description copied from class:JavaType
Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.- Overrides:
getContentValueHandler
in classJavaType
- Returns:
- Content value handler associated with this type, if any.
-
getContentTypeHandler
public java.lang.Object getContentTypeHandler()
Description copied from class:JavaType
Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind. May be removed from Jackson 3.0.- Overrides:
getContentTypeHandler
in classJavaType
- Returns:
- Content type handler associated with this type, if any.
-
hasHandlers
public boolean hasHandlers()
Description copied from class:JavaType
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.- Overrides:
hasHandlers
in classJavaType
-
getErasedSignature
public java.lang.StringBuilder getErasedSignature(java.lang.StringBuilder sb)
Description copied from class:JavaType
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.- Specified by:
getErasedSignature
in classTypeBase
- Parameters:
sb
- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
getGenericSignature
public java.lang.StringBuilder getGenericSignature(java.lang.StringBuilder sb)
- Specified by:
getGenericSignature
in classTypeBase
- Parameters:
sb
- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
isTrueCollectionType
@Deprecated public boolean isTrueCollectionType()
Deprecated.Since 2.12 just use instanceofMethod that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype ofCollection
or just something that acts like one.
-
-