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

public Class IterationType

extends SimpleType
Class Inheritance
Imports
java.util.Objects, com.fasterxml.jackson.databind.JavaType
Specialized SimpleType for types that are allow iteration over Collection(-like) types: this includes types like java.util.Iterator. Iterated (content) type is accessible using getContentType().
Since
2.16

Field Summary

Modifier and TypeField and Description
protected final JavaType
_iteratedType

private static final long
serialVersionUID

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

Constructor Summary

AccessConstructor and Description
protected
IterationType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType iteratedType, Object valueHandler, Object typeHandler, boolean asStatic)

protected
IterationType(TypeBase base, JavaType iteratedType)

Constructor used when upgrading into this type (via upgradeFrom, the usual way for IterationTypes to come into existence.

Method Summary

Modifier and TypeMethod and Description
protected String
buildCanonicalName()

Overrides com.fasterxml.jackson.databind.type.SimpleType.buildCanonicalName.

public static IterationType
construct(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType iteratedType)

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 StringBuilder
getErasedSignature(StringBuilder
StringBuilder to append signature to
sb)

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

Overrides com.fasterxml.jackson.databind.type.SimpleType.getGenericSignature.

public boolean
hasContentType()

Overrides com.fasterxml.jackson.databind.type.SimpleType.hasContentType.

Accessor that allows determining whether getContentType() should return a non-null value (that is, there is a "content type") or not.
public boolean
isIterationType()

Overrides com.fasterxml.jackson.databind.JavaType.isIterationType.

Method that returns true if this instance is of type IterationType.
public JavaType
refine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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 static IterationType
upgradeFrom(JavaType
Resolved non-iteration type (usually SimpleType) that is being upgraded
baseType, JavaType
Iterated type; usually the first and only type parameter, but not necessarily
iteratedType)

Factory method that can be used to "upgrade" a basic type into iteration type; usually done via TypeModifier

public JavaType
withContentType(JavaType contentType)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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 IterationType
withContentTypeHandler(Object
Handler to pass to new instance created
h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.withContentTypeHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public IterationType
withContentValueHandler(Object
Handler to pass to new instance created
h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.withContentValueHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public IterationType
withStaticTyping()

Overrides com.fasterxml.jackson.databind.type.SimpleType.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 IterationType
withTypeHandler(Object
Handler to pass to new instance created
h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.withTypeHandler.

Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public IterationType
withValueHandler(Object
Handler to pass to new instance created
h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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.SimpleType:
constructconstructUnsafeequalsisContainerTypetoString

Field Detail

_iteratedTypeback to summary
protected final JavaType _iteratedType
serialVersionUIDback to summary
private static final long serialVersionUID

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

Constructor Detail

IterationTypeback to summary
protected IterationType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType iteratedType, Object valueHandler, Object typeHandler, boolean asStatic)
IterationTypeback to summary
protected IterationType(TypeBase base, JavaType iteratedType)

Constructor used when upgrading into this type (via upgradeFrom, the usual way for IterationTypes to come into existence. Sets up what is considered the "base" iteration type

Method Detail

buildCanonicalNameback to summary
protected String buildCanonicalName()

Overrides com.fasterxml.jackson.databind.type.SimpleType.buildCanonicalName.

Annotations
@Override
constructback to summary
public static IterationType construct(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType iteratedType)
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
getErasedSignatureback to summary
public StringBuilder getErasedSignature(StringBuilder sb)

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

Overrides com.fasterxml.jackson.databind.type.SimpleType.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
hasContentTypeback to summary
public boolean hasContentType()

Overrides com.fasterxml.jackson.databind.type.SimpleType.hasContentType.

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

Accessor that allows determining whether getContentType() should return a non-null value (that is, there is a "content type") or not. True if isContainerType() or isReferenceType() return true.

Annotations
@Override
isIterationTypeback to summary
public boolean isIterationType()

Overrides com.fasterxml.jackson.databind.JavaType.isIterationType.

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

Method that returns true if this instance is of type IterationType.

Returns:boolean

True if this type is considered "iteration type"

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

Overrides com.fasterxml.jackson.databind.type.SimpleType.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
upgradeFromback to summary
public static IterationType upgradeFrom(JavaType baseType, JavaType iteratedType)

Factory method that can be used to "upgrade" a basic type into iteration type; usually done via TypeModifier

Parameters
baseType:JavaType

Resolved non-iteration type (usually SimpleType) that is being upgraded

iteratedType:JavaType

Iterated type; usually the first and only type parameter, but not necessarily

withContentTypeback to summary
public JavaType withContentType(JavaType contentType)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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 IterationType withContentTypeHandler(Object h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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:IterationType

Newly created type instance with same type information, specified handler

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

Overrides com.fasterxml.jackson.databind.type.SimpleType.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:IterationType

Newly created type instance with same type information, specified handler

Annotations
@Override
withStaticTypingback to summary
public IterationType withStaticTyping()

Overrides com.fasterxml.jackson.databind.type.SimpleType.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 IterationType withTypeHandler(Object h)

Overrides com.fasterxml.jackson.databind.type.SimpleType.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:IterationType

Newly created type instance with same type information, specified handler

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

Overrides com.fasterxml.jackson.databind.type.SimpleType.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:IterationType

Newly created type instance with same type information, specified handler

Annotations
@Override