Jackson 3.0.1 · tools.jackson.databind.type.SimpleType

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.type.TypeBase.serialVersionUID.

Access	Constructor and Description
protected	SimpleType(Class<?> cls) Constructor only used by core Jackson databind functionality; should never be called by application code.
protected	SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts)
protected	SimpleType(TypeBase base) Simple copy-constructor, usually used when upgrading/refining a simple type into more specialized type.
protected	SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, Object valueHandler, Object typeHandler, boolean asStatic)
protected	SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, int extraHash, Object valueHandler, Object typeHandler, boolean asStatic) Pass-through constructor used by `ReferenceType`.

Method Summary

Modifier and Type	Method and Description
protected String	buildCanonicalName() Overrides tools.jackson.databind.type.TypeBase.buildCanonicalName.
public static SimpleType	constructUnsafe(Class<?> raw) Method used by core Jackson classes: NOT to be used by application code: it does NOT properly handle inspection of super-types, so neither parent Classes nor implemented Interfaces are accessible with resulting type instance.
public boolean	equals(Object o) Implements abstract tools.jackson.databind.JavaType.equals. Indicates whether some other object is "equal to" this one.
public StringBuilder	getErasedSignature(StringBuilder sb) Implements abstract tools.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 sb) Implements abstract tools.jackson.databind.type.TypeBase.getGenericSignature.
public boolean	hasContentType() Overrides tools.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.
public boolean	isContainerType() Implements abstract tools.jackson.databind.JavaType.isContainerType.
public JavaType	refine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces) Implements abstract tools.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 tools.jackson.databind.JavaType.toString. Returns a string representation of the object.
public JavaType	withContentType(JavaType contentType) Implements abstract tools.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 JavaType	withContentTypeHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withContentTypeHandler. Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public SimpleType	withContentValueHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withContentValueHandler. Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public SimpleType	withStaticTyping() Implements abstract tools.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 SimpleType	withTypeHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withTypeHandler. Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.
public SimpleType	withValueHandler(Object h) Implements abstract tools.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 tools.jackson.databind.type.TypeBase:: _classSignature _hasNTypeParameters containedType containedTypeCount findSuperType findTypeParameters getBindings getInterfaces getSuperClass serialize serializeWithType toCanonical

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.type.TypeBase.serialVersionUID.

SimpleType	back to summary
protected SimpleType(Class<?> cls) Constructor only used by core Jackson databind functionality; should never be called by application code. As with other direct construction that by-passes `TypeFactory`, no introspection occurs with respect to super-types; caller must be aware of consequences if using this method.

SimpleType	back to summary
protected SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts)

SimpleType	back to summary
protected SimpleType(TypeBase base) Simple copy-constructor, usually used when upgrading/refining a simple type into more specialized type.

SimpleType	back to summary
protected SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, Object valueHandler, Object typeHandler, boolean asStatic)

SimpleType	back to summary
protected SimpleType(Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, int extraHash, Object valueHandler, Object typeHandler, boolean asStatic) Pass-through constructor used by `ReferenceType`. Since 2.6

Method Detail

buildCanonicalName	back to summary
protected String buildCanonicalName() Overrides tools.jackson.databind.type.TypeBase.buildCanonicalName. Annotations @Override

buildCanonicalName

back to summary

protected String buildCanonicalName()

Overrides tools.jackson.databind.type.TypeBase.buildCanonicalName.

Annotations

@Override

constructUnsafe	back to summary
public static SimpleType constructUnsafe(Class<?> raw) Method used by core Jackson classes: NOT to be used by application code: it does NOT properly handle inspection of super-types, so neither parent Classes nor implemented Interfaces are accessible with resulting type instance. Note public only because it is called by `ObjectMapper` which is not in same package

equals back to summary

equals	back to summary
public boolean equals(Object o) Implements abstract tools.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. Annotations @Override

public boolean equals(Object o)

Implements abstract tools.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.

Annotations

@Override

getErasedSignature	back to summary
public StringBuilder getErasedSignature(StringBuilder sb) Implements abstract tools.jackson.databind.type.TypeBase.getErasedSignature. Doc from tools.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. Annotations @Override

getErasedSignature

back to summary

public StringBuilder getErasedSignature(StringBuilder sb)

Implements abstract tools.jackson.databind.type.TypeBase.getErasedSignature.

Doc from tools.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.

Annotations

@Override

getGenericSignature	back to summary
public StringBuilder getGenericSignature(StringBuilder sb) Implements abstract tools.jackson.databind.type.TypeBase.getGenericSignature. Annotations @Override

getGenericSignature

back to summary

public StringBuilder getGenericSignature(StringBuilder sb)

Implements abstract tools.jackson.databind.type.TypeBase.getGenericSignature.

Annotations

@Override

hasContentType back to summary

hasContentType	back to summary
public boolean hasContentType() Overrides tools.jackson.databind.JavaType.hasContentType. Doc from tools.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

public boolean hasContentType()

Overrides tools.jackson.databind.JavaType.hasContentType.

Doc from tools.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

isContainerType	back to summary
public boolean isContainerType() Implements abstract tools.jackson.databind.JavaType.isContainerType. Annotations @Override

isContainerType

back to summary

public boolean isContainerType()

Implements abstract tools.jackson.databind.JavaType.isContainerType.

Annotations

@Override

refine	back to summary
public JavaType refine(Class<?> rawType, TypeBindings bindings, JavaType superClass, JavaType[] superInterfaces) Implements abstract tools.jackson.databind.JavaType.refine. Doc from tools.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

refine

back to summary

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

Implements abstract tools.jackson.databind.JavaType.refine.

Doc from tools.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

toString back to summary

toString	back to summary
public String toString() Implements abstract tools.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. Annotations @Override

public String toString()

Implements abstract tools.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.

Annotations

@Override

withContentType back to summary

withContentType	back to summary
public JavaType withContentType(JavaType contentType) Implements abstract tools.jackson.databind.JavaType.withContentType. Doc from tools.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. Annotations @Override

public JavaType withContentType(JavaType contentType)

Implements abstract tools.jackson.databind.JavaType.withContentType.

Doc from tools.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.

Annotations

@Override

withContentTypeHandler	back to summary
public JavaType withContentTypeHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withContentTypeHandler. Doc from tools.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. Annotations @Override

withContentTypeHandler

back to summary

public JavaType withContentTypeHandler(Object h)

Implements abstract tools.jackson.databind.JavaType.withContentTypeHandler.

Doc from tools.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.

Annotations

@Override

withContentValueHandler	back to summary
public SimpleType withContentValueHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withContentValueHandler. Doc from tools.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. Annotations @Override

withContentValueHandler

back to summary

public SimpleType withContentValueHandler(Object h)

Implements abstract tools.jackson.databind.JavaType.withContentValueHandler.

Doc from tools.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.

Annotations

@Override

withStaticTyping	back to summary
public SimpleType withStaticTyping() Implements abstract tools.jackson.databind.JavaType.withStaticTyping. Doc from tools.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

withStaticTyping

back to summary

public SimpleType withStaticTyping()

Implements abstract tools.jackson.databind.JavaType.withStaticTyping.

Doc from tools.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

withTypeHandler	back to summary
public SimpleType withTypeHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withTypeHandler. Doc from tools.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. Annotations @Override

withTypeHandler

back to summary

public SimpleType withTypeHandler(Object h)

Implements abstract tools.jackson.databind.JavaType.withTypeHandler.

Doc from tools.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.

Annotations

@Override

withValueHandler	back to summary
public SimpleType withValueHandler(Object h) Implements abstract tools.jackson.databind.JavaType.withValueHandler. Doc from tools.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. Annotations @Override

withValueHandler

back to summary

public SimpleType withValueHandler(Object h)

Implements abstract tools.jackson.databind.JavaType.withValueHandler.

Doc from tools.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.

Annotations

@Override

public Class SimpleType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail