Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.type

public final Class ArrayType

extends TypeBase
Class Inheritance
Imports
java.lang.reflect.Array, com.fasterxml.jackson.databind.JavaType
Array types represent Java arrays, both primitive and object valued. Further, Object-valued arrays can have element type of any other legal JavaType.

Field Summary

Modifier and TypeField and 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.

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.type.TypeBase.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.type.TypeBase:
_bindings_superClass_superInterfaces

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public static ArrayType
construct(JavaType componentType, TypeBindings bindings)

public static ArrayType
construct(JavaType componentType, TypeBindings bindings, Object valueHandler, Object typeHandler)

public boolean
equals(Object
the reference object with which to compare.
o)

Implements abstract com.fasterxml.jackson.databind.JavaType.equals.

Indicates whether some other object is "equal to" this one.

public JavaType
getContentType()

Overrides com.fasterxml.jackson.databind.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)

public Object
getContentTypeHandler()

Overrides com.fasterxml.jackson.databind.JavaType.getContentTypeHandler.

Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.

public Object
getContentValueHandler()

Overrides com.fasterxml.jackson.databind.JavaType.getContentValueHandler.

Internal accessor that should not be used by any code outside of jackson-databind: only used internally by databind.

public Object[]
getEmptyArray()

public StringBuilder
getErasedSignature(StringBuilder
StringBuilder to append signature to
sb)

Implements abstract com.fasterxml.jackson.databind.type.TypeBase.getErasedSignature.

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.

public StringBuilder
getGenericSignature(StringBuilder
StringBuilder to append signature to
sb)

Implements abstract com.fasterxml.jackson.databind.type.TypeBase.getGenericSignature.

public boolean
hasGenericTypes()

Overrides com.fasterxml.jackson.databind.JavaType.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).

public boolean
hasHandlers()

Overrides com.fasterxml.jackson.databind.JavaType.hasHandlers.

Helper method that checks whether this type, or its (optional) key or content type has getValueHandler or getTypeHandler(); that is, are there any non-standard handlers associated with this type object.

public boolean
isAbstract()

Overrides com.fasterxml.jackson.databind.JavaType.isAbstract.

For some odd reason, modifiers for array classes would claim they are abstract types.

public boolean
isArrayType()

Overrides com.fasterxml.jackson.databind.JavaType.isArrayType.

public boolean
isConcrete()

Overrides com.fasterxml.jackson.databind.JavaType.isConcrete.

For some odd reason, modifiers for array classes would claim they are abstract types.

public boolean
isContainerType()

Implements abstract com.fasterxml.jackson.databind.JavaType.isContainerType.

public JavaType
refine(Class<?> contentClass, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)

Implements abstract com.fasterxml.jackson.databind.JavaType.refine.

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.

public String
toString()

Implements abstract com.fasterxml.jackson.databind.JavaType.toString.

Returns a string representation of the object.

public JavaType
withContentType(JavaType contentType)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentType.

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.

public ArrayType
withContentTypeHandler(Object
Handler to pass to new instance created
h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentTypeHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.

public ArrayType
withContentValueHandler(Object
Handler to pass to new instance created
h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentValueHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.

public ArrayType
withStaticTyping()

Implements abstract com.fasterxml.jackson.databind.JavaType.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.

public ArrayType
withTypeHandler(Object
Handler to pass to new instance created
h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withTypeHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.

public ArrayType
withValueHandler(Object
Handler to pass to new instance created
h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withValueHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.

Inherited from com.fasterxml.jackson.databind.type.TypeBase:
_bogusSuperClass_classSignature_hasNTypeParametersbuildCanonicalNamecontainedTypecontainedTypeCountcontainedTypeNamefindSuperTypefindTypeParametersgetBindingsgetInterfacesgetSuperClassserializeserializeWithTypetoCanonical

Field Detail

_componentTypeback to summary
protected final JavaType _componentType

Type of elements in the array.

_emptyArrayback to summary
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.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.type.TypeBase.serialVersionUID.

Constructor Detail

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

Method Detail

constructback to summary
public static ArrayType construct(JavaType componentType, TypeBindings bindings)
constructback to summary
public static ArrayType construct(JavaType componentType, TypeBindings bindings, Object valueHandler, Object typeHandler)
equalsback to summary
public boolean equals(Object o)

Implements abstract com.fasterxml.jackson.databind.JavaType.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getContentTypeback to summary
public JavaType getContentType()

Overrides com.fasterxml.jackson.databind.JavaType.getContentType.

Doc from com.fasterxml.jackson.core.type.ResolvedType.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)

Returns:JavaType

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

Annotations
@Override
getContentTypeHandlerback to summary
public Object getContentTypeHandler()

Overrides com.fasterxml.jackson.databind.JavaType.getContentTypeHandler.

Doc from com.fasterxml.jackson.databind.JavaType.getContentTypeHandler.

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.

Returns:Object

Content type handler associated with this type, if any.

Annotations
@Override
getContentValueHandlerback to summary
public Object getContentValueHandler()

Overrides com.fasterxml.jackson.databind.JavaType.getContentValueHandler.

Doc from com.fasterxml.jackson.databind.JavaType.getContentValueHandler.

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.

Returns:Object

Content value handler associated with this type, if any.

Annotations
@Override
getEmptyArrayback to summary
public Object[] getEmptyArray()
Since
2.12
getErasedSignatureback to summary
public StringBuilder getErasedSignature(StringBuilder sb)

Implements abstract com.fasterxml.jackson.databind.type.TypeBase.getErasedSignature.

Doc from com.fasterxml.jackson.databind.JavaType.getErasedSignature.

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.

Parameters
sb:StringBuilder

StringBuilder to append signature to

Returns:StringBuilder

StringBuilder that was passed in; returned to allow call chaining

Annotations
@Override
getGenericSignatureback to summary
public StringBuilder getGenericSignature(StringBuilder sb)

Implements abstract com.fasterxml.jackson.databind.type.TypeBase.getGenericSignature.

Parameters
sb:StringBuilder

Doc from com.fasterxml.jackson.databind.JavaType.getGenericSignature.

StringBuilder to append signature to

Returns:StringBuilder

Doc from com.fasterxml.jackson.databind.JavaType.getGenericSignature.

StringBuilder that was passed in; returned to allow call chaining

Annotations
@Override
hasGenericTypesback to summary
public boolean hasGenericTypes()

Overrides com.fasterxml.jackson.databind.JavaType.hasGenericTypes.

Doc from com.fasterxml.jackson.core.type.ResolvedType.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).

Returns:boolean

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

Annotations
@Override
hasHandlersback to summary
public boolean hasHandlers()

Overrides com.fasterxml.jackson.databind.JavaType.hasHandlers.

Doc from com.fasterxml.jackson.databind.JavaType.hasHandlers.

Helper method that checks whether this type, or its (optional) key or content type has getValueHandler or getTypeHandler(); that is, are there any non-standard handlers associated with this type object.

Annotations
@Override
isAbstractback to summary
public boolean isAbstract()

Overrides com.fasterxml.jackson.databind.JavaType.isAbstract.

For some odd reason, modifiers for array classes would claim they are abstract types. Not so, at least for our purposes.

Annotations
@Override
isArrayTypeback to summary
public boolean isArrayType()

Overrides com.fasterxml.jackson.databind.JavaType.isArrayType.

Annotations
@Override
isConcreteback to summary
public boolean isConcrete()

Overrides com.fasterxml.jackson.databind.JavaType.isConcrete.

For some odd reason, modifiers for array classes would claim they are abstract types. Not so, at least for our purposes.

Annotations
@Override
isContainerTypeback to summary
public boolean isContainerType()

Implements abstract com.fasterxml.jackson.databind.JavaType.isContainerType.

Returns:boolean

Doc from com.fasterxml.jackson.databind.JavaType.isContainerType.

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

Annotations
@Override
refineback to summary
public JavaType refine(Class<?> contentClass, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)

Implements abstract com.fasterxml.jackson.databind.JavaType.refine.

Doc from com.fasterxml.jackson.databind.JavaType.refine.

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.

Annotations
@Override
toStringback to summary
public String toString()

Implements abstract com.fasterxml.jackson.databind.JavaType.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
withContentTypeback to summary
public JavaType withContentType(JavaType contentType)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentType.

Doc from com.fasterxml.jackson.databind.JavaType.withContentType.

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.

Returns:JavaType

Newly created type instance

Annotations
@Override
withContentTypeHandlerback to summary
public ArrayType withContentTypeHandler(Object h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentTypeHandler.

Doc from com.fasterxml.jackson.databind.JavaType.withContentTypeHandler.

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.

Parameters
h:Object

Handler to pass to new instance created

Returns:ArrayType

Newly created type instance with same type information, specified handler

Annotations
@Override
withContentValueHandlerback to summary
public ArrayType withContentValueHandler(Object h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withContentValueHandler.

Doc from com.fasterxml.jackson.databind.JavaType.withContentValueHandler.

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.

Parameters
h:Object

Handler to pass to new instance created

Returns:ArrayType

Newly created type instance with same type information, specified handler

Annotations
@Override
withStaticTypingback to summary
public ArrayType withStaticTyping()

Implements abstract com.fasterxml.jackson.databind.JavaType.withStaticTyping.

Doc from com.fasterxml.jackson.databind.JavaType.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. 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).

Annotations
@Override
withTypeHandlerback to summary
public ArrayType withTypeHandler(Object h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withTypeHandler.

Doc from com.fasterxml.jackson.databind.JavaType.withTypeHandler.

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.

Parameters
h:Object

Handler to pass to new instance created

Returns:ArrayType

Newly created type instance with same type information, specified handler

Annotations
@Override
withValueHandlerback to summary
public ArrayType withValueHandler(Object h)

Implements abstract com.fasterxml.jackson.databind.JavaType.withValueHandler.

Doc from com.fasterxml.jackson.databind.JavaType.withValueHandler.

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.

Parameters
h:Object

Handler to pass to new instance created

Returns:ArrayType

Newly created type instance with same type information, specified handler

Annotations
@Override