Class ArrayType

  • All Implemented Interfaces:
    JsonSerializable, java.io.Serializable, java.lang.reflect.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
    • Method Detail

      • construct

        public static ArrayType construct​(JavaType componentType,
                                          TypeBindings bindings,
                                          java.lang.Object valueHandler,
                                          java.lang.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​(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 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​(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 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​(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 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​(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 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​(java.lang.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
      • 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 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 class JavaType
        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 class JavaType
        Returns:
        Content type handler associated with this type, if any.
      • getGenericSignature

        public java.lang.StringBuilder getGenericSignature​(java.lang.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 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 class TypeBase
        Parameters:
        sb - StringBuilder to append signature to
        Returns:
        StringBuilder that was passed in; returned to allow call chaining
      • getEmptyArray

        public java.lang.Object[] getEmptyArray()
        Since:
        2.12
      • toString

        public java.lang.String toString()
        Specified by:
        toString in class JavaType
      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in class JavaType