Package com.fasterxml.jackson.databind.type

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 legal JavaType.

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 final JavaType	_componentType	Type of elements in the array.
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.

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
protected	ArrayType(JavaType componentType, TypeBindings bindings, Object emptyInstance, Object valueHandler, Object typeHandler, boolean asStatic)

Method Summary

Modifier and Type	Method	Description
static ArrayType	construct(JavaType componentType, TypeBindings bindings)
static ArrayType	construct(JavaType componentType, TypeBindings bindings, Object valueHandler, Object typeHandler)
boolean	equals(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)
Object	getContentTypeHandler()	Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.
Object	getContentValueHandler()	Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.
Object[]	getEmptyArray()
StringBuilder	getErasedSignature(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.
StringBuilder	getGenericSignature(StringBuilder sb)
boolean	hasGenericTypes()	Method that can be used to find out if the type directly declares generic parameters (for its direct super-class and/or super-interfaces).
boolean	hasHandlers()	Helper method that checks whether this type, or its (optional) key or content type has JavaType.getValueHandler() or JavaType.getTypeHandler(); that is, are there any non-standard handlers associated with this type object.
boolean	isAbstract()	For some odd reason, modifiers for array classes would claim they are abstract types.
boolean	isArrayType()
boolean	isConcrete()	For some odd reason, modifiers for array classes would claim they are abstract types.
boolean	isContainerType()
JavaType	refine(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.
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.
ArrayType	withContentTypeHandler(Object h)	Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
ArrayType	withContentValueHandler(Object h)	Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
ArrayType	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.
ArrayType	withTypeHandler(Object h)	Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
ArrayType	withValueHandler(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

_bogusSuperClass, _classSignature, _hasNTypeParameters, buildCanonicalName, containedType, containedTypeCount, containedTypeName, findSuperType, findTypeParameters, getBindings, getInterfaces, getSuperClass, serialize, serializeWithType, toCanonical

Methods inherited from class com.fasterxml.jackson.databind.JavaType

_narrow, containedTypeOrUnknown, forcedNarrowBy, getErasedSignature, getGenericSignature, getKeyType, getParameterSource, getRawClass, getReferencedType, getTypeHandler, getValueHandler, hasContentType, hashCode, hasRawClass, hasValueHandler, isCollectionLikeType, isEnumImplType, isEnumType, isFinal, isInterface, isIterationType, isJavaLangObject, isMapLikeType, isPrimitive, isRecordType, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType, withHandlersFrom

Methods inherited from class com.fasterxml.jackson.core.type.ResolvedType

isReferenceType

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 Details

_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 Details

ArrayType

protected ArrayType(JavaType componentType,
 TypeBindings bindings,
 Object emptyInstance,
 Object valueHandler,
 Object typeHandler,
 boolean asStatic)

Method Details

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: 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 with SimpleType), IllegalArgumentException will be thrown.

Specified by:

withContentType in class JavaType

Returns:

Newly created type instance

withTypeHandler

public ArrayType withTypeHandler(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 class JavaType

Parameters:

h - Handler to pass to new instance created

Returns:

Newly created type instance with same type information, specified handler

withContentTypeHandler

public ArrayType withContentTypeHandler(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 class JavaType

Parameters:

h - Handler to pass to new instance created

Returns:

Newly created type instance with same type information, specified handler

withValueHandler

public ArrayType withValueHandler(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 class JavaType

Parameters:

h - Handler to pass to new instance created

Returns:

Newly created type instance with same type information, specified handler

withContentValueHandler

public ArrayType withContentValueHandler(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 class JavaType

Parameters:

h - Handler to pass to new instance created

Returns:

Newly created type instance with same type information, specified handler

withStaticTyping

public ArrayType 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 class JavaType

refine

public JavaType refine(Class<?> contentClass,
 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.

Specified by:

refine in class JavaType

isArrayType

public boolean isArrayType()

Overrides:

isArrayType in class JavaType

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:

isAbstract in class JavaType

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:

isConcrete in class JavaType

hasGenericTypes

public boolean hasGenericTypes()

Description copied from class: ResolvedType

Method that can be used to find out if the type directly declares generic parameters (for its direct super-class and/or super-interfaces).

Overrides:

hasGenericTypes in class JavaType

Returns:

True if this type has generic type parameters, false if not

isContainerType

public boolean isContainerType()

Specified by:

isContainerType in class JavaType

Returns:

True if type represented is a container type; this includes array, Map and Collection types.

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 class JavaType

Returns:

Content type of this type, if any; null if none

getContentValueHandler

public 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 class JavaType

Returns:

Content value handler associated with this type, if any.

getContentTypeHandler

public 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 class JavaType

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 has JavaType.getValueHandler() or JavaType.getTypeHandler(); that is, are there any non-standard handlers associated with this type object.

Overrides:

hasHandlers in class JavaType

getGenericSignature

public StringBuilder getGenericSignature(StringBuilder sb)

Specified by:

getGenericSignature in class TypeBase

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: 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 class TypeBase

Parameters:

sb - StringBuilder to append signature to

Returns:

StringBuilder that was passed in; returned to allow call chaining

getEmptyArray

public Object[] getEmptyArray()

Since:

2.12

toString

public String toString()

Specified by:

toString in class JavaType

equals

public boolean equals(Object o)

Specified by:

equals in class JavaType