Class CollectionType
- 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
-
- com.fasterxml.jackson.databind.type.CollectionType
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
,java.lang.reflect.Type
public final class CollectionType extends CollectionLikeType
Type that represents Java Collection types (Lists, Sets).- 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 CollectionType
construct(java.lang.Class<?> rawType, JavaType elemT)
Deprecated.Since 2.7, remove from 2.9static CollectionType
construct(java.lang.Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType elemT)
JavaType
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()
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.CollectionType
withContentTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionType
withContentValueHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionType
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.CollectionType
withTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.CollectionType
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.CollectionLikeType
equals, getContentType, getContentTypeHandler, getContentValueHandler, getErasedSignature, getGenericSignature, hasHandlers, isCollectionLikeType, isContainerType, isTrueCollectionType, upgradeFrom, withHandlersFrom
-
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 CollectionType construct(java.lang.Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType elemT)
- Since:
- 2.7
-
construct
@Deprecated public static CollectionType construct(java.lang.Class<?> rawType, JavaType elemT)
Deprecated.Since 2.7, remove from 2.9
-
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.- Overrides:
withContentType
in classCollectionLikeType
- Returns:
- Newly created type instance
-
withTypeHandler
public CollectionType 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.
- Overrides:
withTypeHandler
in classCollectionLikeType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentTypeHandler
public CollectionType 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.
- Overrides:
withContentTypeHandler
in classCollectionLikeType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withValueHandler
public CollectionType 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.
- Overrides:
withValueHandler
in classCollectionLikeType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentValueHandler
public CollectionType 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.
- Overrides:
withContentValueHandler
in classCollectionLikeType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withStaticTyping
public CollectionType 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).- Overrides:
withStaticTyping
in classCollectionLikeType
-
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.- Overrides:
refine
in classCollectionLikeType
-
toString
public java.lang.String toString()
- Overrides:
toString
in classCollectionLikeType
-
-