Class ArrayType
- 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.ArrayType
-
- All Implemented Interfaces:
JsonSerializable,Serializable,Type
public final class ArrayType extends TypeBase
Array types represent Java arrays, both primitive and object valued. Further, Object-valued arrays can have element type of any other legalJavaType.- 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_componentTypeType of elements in the array.protected Object_emptyArrayWe will also keep track of shareable instance of empty array, since it usually needs to be constructed any way; and because it is essentially immutable and thus can be shared.-
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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected JavaType_narrow(Class<?> subclass)Deprecated.static ArrayTypeconstruct(JavaType componentType, TypeBindings bindings)static ArrayTypeconstruct(JavaType componentType, TypeBindings bindings, Object valueHandler, Object typeHandler)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)booleanhasGenericTypes()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.booleanisAbstract()For some odd reason, modifiers for array classes would claim they are abstract types.booleanisArrayType()booleanisConcrete()For some odd reason, modifiers for array classes would claim they are abstract types.booleanisContainerType()JavaTyperefine(Class<?> contentClass, 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()JavaTypewithContentType(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.ArrayTypewithContentTypeHandler(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.ArrayTypewithContentValueHandler(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.ArrayTypewithStaticTyping()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.ArrayTypewithTypeHandler(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.ArrayTypewithValueHandler(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, buildCanonicalName, 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, hashCode, hasRawClass, hasValueHandler, isCollectionLikeType, isEnumType, isFinal, isInterface, isJavaLangObject, isMapLikeType, isPrimitive, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType, withHandlersFrom
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.reflect.Type
getTypeName
-
-
-
-
Field Detail
-
_componentType
protected final JavaType _componentType
Type of elements in the array.
-
_emptyArray
protected final Object _emptyArray
We will also keep track of shareable instance of empty array, since it usually needs to be constructed any way; and because it is essentially immutable and thus can be shared.
-
-
Constructor Detail
-
ArrayType
protected ArrayType(JavaType componentType, TypeBindings bindings, Object emptyInstance, Object valueHandler, Object typeHandler, boolean asStatic)
-
-
Method Detail
-
construct
public static ArrayType construct(JavaType componentType, TypeBindings bindings)
-
construct
public static ArrayType construct(JavaType componentType, TypeBindings bindings, Object valueHandler, Object typeHandler)
-
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 ArrayType 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 ArrayType 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 ArrayType 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 ArrayType 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
-
withStaticTyping
public ArrayType 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
-
_narrow
@Deprecated protected JavaType _narrow(Class<?> subclass)
Deprecated.Handling of narrowing conversions for arrays is trickier: for now, it is not even allowed.
-
refine
public JavaType refine(Class<?> contentClass, 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.
-
isArrayType
public boolean isArrayType()
- Overrides:
isArrayTypein classJavaType
-
isAbstract
public boolean isAbstract()
For some odd reason, modifiers for array classes would claim they are abstract types. Not so, at least for our purposes.- Overrides:
isAbstractin classJavaType
-
isConcrete
public boolean isConcrete()
For some odd reason, modifiers for array classes would claim they are abstract types. Not so, at least for our purposes.- Overrides:
isConcretein classJavaType
-
hasGenericTypes
public boolean hasGenericTypes()
- Overrides:
hasGenericTypesin classJavaType
-
isContainerType
public boolean isContainerType()
- Specified by:
isContainerTypein classJavaType- Returns:
- True if type represented is a container type; this includes array, Map and Collection types.
-
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
-
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
-
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
-
-