Class SimpleType
- 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.SimpleType
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
,java.lang.reflect.Type
- Direct Known Subclasses:
ReferenceType
public class SimpleType extends TypeBase
Simple types are defined as anything other than one of recognized container types (arrays, Collections, Maps). For our needs we need not know anything further, since we have no way of dealing with generic types other than Collections and Maps.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable
JsonSerializable.Base
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static SimpleType
construct(java.lang.Class<?> cls)
Deprecated.Since 2.7static SimpleType
constructUnsafe(java.lang.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.boolean
equals(java.lang.Object o)
java.lang.StringBuilder
getErasedSignature(java.lang.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.java.lang.StringBuilder
getGenericSignature(java.lang.StringBuilder sb)
boolean
hasContentType()
Accessor that allows determining whetherJavaType.getContentType()
should return a non-null value (that is, there is a "content type") or not.boolean
isContainerType()
JavaType
refine(java.lang.Class<?> rawType, 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.java.lang.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.JavaType
withContentTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.SimpleType
withContentValueHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.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.SimpleType
withTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.SimpleType
withValueHandler(java.lang.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
containedType, containedTypeCount, containedTypeName, findSuperType, findTypeParameters, getBindings, getInterfaces, getSuperClass, serialize, serializeWithType, toCanonical
-
Methods inherited from class com.fasterxml.jackson.databind.JavaType
containedTypeOrUnknown, forcedNarrowBy, getContentType, getContentTypeHandler, getContentValueHandler, getErasedSignature, getGenericSignature, getKeyType, getParameterSource, getRawClass, getReferencedType, getTypeHandler, getValueHandler, hasGenericTypes, hasHandlers, hashCode, hasRawClass, hasValueHandler, isAbstract, isArrayType, isCollectionLikeType, isConcrete, isEnumImplType, isEnumType, isFinal, isInterface, isJavaLangObject, isMapLikeType, isPrimitive, isRecordType, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType, withHandlersFrom
-
Methods inherited from class com.fasterxml.jackson.core.type.ResolvedType
isReferenceType
-
-
-
-
Method Detail
-
constructUnsafe
public static SimpleType constructUnsafe(java.lang.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
-
construct
@Deprecated public static SimpleType construct(java.lang.Class<?> cls)
Deprecated.Since 2.7Method that should 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. Instead, please useTypeFactory
'sconstructType
methods which handle introspection appropriately.Note that prior to 2.7, method usage was not limited and would typically have worked acceptably: the problem comes from inability to resolve super-type information, for which
TypeFactory
is needed.
-
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 withSimpleType
),IllegalArgumentException
will be thrown.- Specified by:
withContentType
in classJavaType
- Returns:
- Newly created type instance
-
withTypeHandler
public SimpleType 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 classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentTypeHandler
public JavaType 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 classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withValueHandler
public SimpleType 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 classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentValueHandler
public SimpleType 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 classJavaType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withStaticTyping
public SimpleType 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 classJavaType
-
refine
public JavaType refine(java.lang.Class<?> rawType, 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.
-
isContainerType
public boolean isContainerType()
- Specified by:
isContainerType
in classJavaType
- Returns:
- True if type represented is a container type; this includes array, Map and Collection types.
-
hasContentType
public boolean hasContentType()
Description copied from class:JavaType
Accessor that allows determining whetherJavaType.getContentType()
should return a non-null value (that is, there is a "content type") or not. True ifJavaType.isContainerType()
orResolvedType.isReferenceType()
return true.- Overrides:
hasContentType
in classJavaType
-
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 classTypeBase
- Parameters:
sb
- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
getGenericSignature
public java.lang.StringBuilder getGenericSignature(java.lang.StringBuilder sb)
- Specified by:
getGenericSignature
in classTypeBase
- Parameters:
sb
- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
-