Class ReferenceType
- 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
-
- com.fasterxml.jackson.databind.type.ReferenceType
-
- All Implemented Interfaces:
JsonSerializable
,java.io.Serializable
,java.lang.reflect.Type
public class ReferenceType extends SimpleType
SpecializedSimpleType
for types that are referential types, that is, values that can be dereferenced to another value (or null), of different type. Referenced type is accessible usinggetContentType()
.- Since:
- 2.6
- 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 ReferenceType
construct(java.lang.Class<?> cls, JavaType refType)
Deprecated.static ReferenceType
construct(java.lang.Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType refType)
boolean
equals(java.lang.Object o)
JavaType
getAnchorType()
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)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)
JavaType
getReferencedType()
Method for accessing type of value that instances of this type references, if any.boolean
hasContentType()
Accessor that allows determining whetherJavaType.getContentType()
should return a non-null value (that is, there is a "content type") or not.boolean
isAnchorType()
Convenience accessor that allows checking whether this is the anchor type itself; if not, it must be one of supertypes that is also aReferenceType
boolean
isReferenceType()
Whether this type is a referential type, meaning that values are basically pointers to "real" values (or null) and not regular values themselves.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()
static ReferenceType
upgradeFrom(JavaType baseType, JavaType refdType)
Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifier
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.ReferenceType
withContentTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.ReferenceType
withContentValueHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.ReferenceType
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.ReferenceType
withTypeHandler(java.lang.Object h)
Internal method that should not be used by any code outside of jackson-databind: only used internally by databind.ReferenceType
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.SimpleType
construct, constructUnsafe, isContainerType
-
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, getContentTypeHandler, getContentValueHandler, getErasedSignature, getGenericSignature, getKeyType, getParameterSource, getRawClass, getTypeHandler, getValueHandler, hasGenericTypes, hasHandlers, hashCode, hasRawClass, hasValueHandler, isAbstract, isArrayType, isCollectionLikeType, isConcrete, isEnumImplType, isEnumType, isFinal, isInterface, isJavaLangObject, isMapLikeType, isPrimitive, isRecordType, isThrowable, isTypeOrSubTypeOf, isTypeOrSuperTypeOf, useStaticType, withHandlersFrom
-
-
-
-
Method Detail
-
upgradeFrom
public static ReferenceType upgradeFrom(JavaType baseType, JavaType refdType)
Factory method that can be used to "upgrade" a basic type into collection-like one; usually done viaTypeModifier
- Parameters:
baseType
- Resolved non-reference type (usuallySimpleType
) that is being upgradedrefdType
- Referenced type; usually the first and only type parameter, but not necessarily- Since:
- 2.7
-
construct
public static ReferenceType construct(java.lang.Class<?> cls, TypeBindings bindings, JavaType superClass, JavaType[] superInts, JavaType refType)
- Since:
- 2.7
-
construct
@Deprecated public static ReferenceType construct(java.lang.Class<?> cls, JavaType refType)
Deprecated.
-
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.- Overrides:
withContentType
in classSimpleType
- Returns:
- Newly created type instance
-
withTypeHandler
public ReferenceType 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.
- Overrides:
withTypeHandler
in classSimpleType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentTypeHandler
public ReferenceType 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.
- Overrides:
withContentTypeHandler
in classSimpleType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withValueHandler
public ReferenceType 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.
- Overrides:
withValueHandler
in classSimpleType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withContentValueHandler
public ReferenceType 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.
- Overrides:
withContentValueHandler
in classSimpleType
- Parameters:
h
- Handler to pass to new instance created- Returns:
- Newly created type instance with same type information, specified handler
-
withStaticTyping
public ReferenceType 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).- Overrides:
withStaticTyping
in classSimpleType
-
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.- Overrides:
refine
in classSimpleType
-
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 classJavaType
- Returns:
- Content type of this type, if any;
null
if none
-
getReferencedType
public JavaType getReferencedType()
Description copied from class:ResolvedType
Method for accessing type of value that instances of this type references, if any.- Overrides:
getReferencedType
in classJavaType
- Returns:
- Referenced type, if any;
null
if not.
-
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 classSimpleType
-
isReferenceType
public boolean isReferenceType()
Description copied from class:ResolvedType
Whether this type is a referential type, meaning that values are basically pointers to "real" values (or null) and not regular values themselves. Typical examples include things likeAtomicReference
, and variousOptional
types (in JDK8, Guava).- Overrides:
isReferenceType
in classResolvedType
- Returns:
True
if this is a "referential" type,false
if not
-
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.- Overrides:
getErasedSignature
in classSimpleType
- 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)
- Overrides:
getGenericSignature
in classSimpleType
- Parameters:
sb
- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
getAnchorType
public JavaType getAnchorType()
-
isAnchorType
public boolean isAnchorType()
Convenience accessor that allows checking whether this is the anchor type itself; if not, it must be one of supertypes that is also aReferenceType
-
toString
public java.lang.String toString()
- Overrides:
toString
in classSimpleType
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classSimpleType
-
-