Package org.codehaus.jackson.map.type
Class MapLikeType
- java.lang.Object
-
- org.codehaus.jackson.type.JavaType
-
- org.codehaus.jackson.map.type.TypeBase
-
- org.codehaus.jackson.map.type.MapLikeType
-
- All Implemented Interfaces:
JsonSerializable,JsonSerializableWithType
- Direct Known Subclasses:
MapType
public class MapLikeType extends TypeBase
Type that represents Map-like types; things that consist of key/value pairs but that do not necessarily implementMap, but that do not have enough introspection functionality to allow for some level of generic handling. This specifically allows framework to check for configuration and annotation settings used for Map types, and pass these to custom handlers that may be more familiar with actual type.- Since:
- 1.8
-
-
Field Summary
Fields Modifier and Type Field Description protected JavaType_keyTypeType of keys of Map.protected JavaType_valueTypeType of values of Map.-
Fields inherited from class org.codehaus.jackson.type.JavaType
_class, _hashCode, _typeHandler, _valueHandler
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMapLikeType(Class<?> mapType, JavaType keyT, JavaType valueT)Deprecated.protectedMapLikeType(Class<?> mapType, JavaType keyT, JavaType valueT, Object valueHandler, Object typeHandler)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected JavaType_narrow(Class<?> subclass)protected StringbuildCanonicalName()static MapLikeTypeconstruct(Class<?> rawType, JavaType keyT, JavaType valueT)JavaTypecontainedType(int index)Method for accessing definitions of contained ("child") types.intcontainedTypeCount()Method for checking how many contained types this type has.StringcontainedTypeName(int index)Not sure if we should count on this, but type names for core interfaces are "K" and "V" respectively.booleanequals(Object o)JavaTypegetContentType()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)StringBuildergetErasedSignature(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.StringBuildergetGenericSignature(StringBuilder sb)JavaTypegetKeyType()Method for accessing key type for this type, assuming type has such a concept (only Map types do)booleanisContainerType()booleanisMapLikeType()booleanisTrueMapType()Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype ofCollectionor just something that acts like one.JavaTypenarrowContentsBy(Class<?> contentClass)JavaTypenarrowKey(Class<?> keySubclass)StringtoString()JavaTypewidenContentsBy(Class<?> contentClass)JavaTypewidenKey(Class<?> keySubclass)MapLikeTypewithContentTypeHandler(Object h)"Copy method" that will construct a new instance that is identical to this instance, except that its content type will have specified type handler assigned.MapLikeTypewithContentValueHandler(Object h)MapLikeTypewithKeyTypeHandler(Object h)MapLikeTypewithKeyValueHandler(Object h)MapLikeTypewithTypeHandler(Object h)"Copy method" that will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.MapLikeTypewithValueHandler(Object h)-
Methods inherited from class org.codehaus.jackson.map.type.TypeBase
_classSignature, getTypeHandler, getValueHandler, serialize, serializeWithType, toCanonical
-
Methods inherited from class org.codehaus.jackson.type.JavaType
_assertSubclass, _widen, forcedNarrowBy, getErasedSignature, getGenericSignature, getRawClass, hasGenericTypes, hashCode, hasRawClass, isAbstract, isArrayType, isCollectionLikeType, isConcrete, isEnumType, isFinal, isInterface, isPrimitive, isThrowable, isTypeOrSubTypeOf, narrowBy, setValueHandler, widenBy
-
-
-
-
Method Detail
-
construct
public static MapLikeType construct(Class<?> rawType, JavaType keyT, JavaType valueT)
-
narrowContentsBy
public JavaType narrowContentsBy(Class<?> contentClass)
- Specified by:
narrowContentsByin classJavaType
-
widenContentsBy
public JavaType widenContentsBy(Class<?> contentClass)
- Specified by:
widenContentsByin classJavaType
-
withTypeHandler
public MapLikeType withTypeHandler(Object h)
Description copied from class:JavaType"Copy method" that will construct a new instance that is identical to this instance, except that it will have specified type handler assigned.- Specified by:
withTypeHandlerin classJavaType- Returns:
- Newly created type instance
-
withContentTypeHandler
public MapLikeType withContentTypeHandler(Object h)
Description copied from class:JavaType"Copy method" that will construct a new instance that is identical to this instance, except that its content type will have specified type handler assigned.- Specified by:
withContentTypeHandlerin classJavaType- Returns:
- Newly created type instance
-
withValueHandler
public MapLikeType withValueHandler(Object h)
- Overrides:
withValueHandlerin classJavaType
-
withContentValueHandler
public MapLikeType withContentValueHandler(Object h)
- Overrides:
withContentValueHandlerin classJavaType
-
buildCanonicalName
protected String buildCanonicalName()
- Specified by:
buildCanonicalNamein classTypeBase
-
isContainerType
public boolean isContainerType()
- Specified by:
isContainerTypein classJavaType- Returns:
- True if type represented is a container type; this includes array, Map and Collection types.
-
isMapLikeType
public boolean isMapLikeType()
- Overrides:
isMapLikeTypein classJavaType- Returns:
- True if type is either true
Maptype, or something similar (meaning it has at least two type parameter; first one describing key type, second value type)
-
getKeyType
public JavaType getKeyType()
Description copied from class:JavaTypeMethod for accessing key type for this type, assuming type has such a concept (only Map types do)- Overrides:
getKeyTypein classJavaType
-
getContentType
public JavaType getContentType()
Description copied from class:JavaTypeMethod 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:
getContentTypein classJavaType
-
containedTypeCount
public int containedTypeCount()
Description copied from class:JavaTypeMethod for checking how many contained types this type has. Contained types are usually generic types, so that generic Maps have 2 contained types.- Overrides:
containedTypeCountin classJavaType
-
containedType
public JavaType containedType(int index)
Description copied from class:JavaTypeMethod for accessing definitions of contained ("child") types.- Overrides:
containedTypein classJavaType- Parameters:
index- Index of contained type to return- Returns:
- Contained type at index, or null if no such type exists (no exception thrown)
-
containedTypeName
public String containedTypeName(int index)
Not sure if we should count on this, but type names for core interfaces are "K" and "V" respectively. For now let's assume this should work.- Overrides:
containedTypeNamein classJavaType- Parameters:
index- Index of contained type to return- Returns:
- Contained type at index, or null if no such type exists (no exception thrown)
-
getErasedSignature
public StringBuilder getErasedSignature(StringBuilder sb)
Description copied from class:JavaTypeMethod 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:
getErasedSignaturein classTypeBase- Parameters:
sb- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
getGenericSignature
public StringBuilder getGenericSignature(StringBuilder sb)
- Specified by:
getGenericSignaturein classTypeBase- Parameters:
sb- StringBuilder to append signature to- Returns:
- StringBuilder that was passed in; returned to allow call chaining
-
withKeyTypeHandler
public MapLikeType withKeyTypeHandler(Object h)
- Since:
- 1.9
-
withKeyValueHandler
public MapLikeType withKeyValueHandler(Object h)
- Since:
- 1.9
-
isTrueMapType
public boolean isTrueMapType()
Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype ofCollectionor just something that acts like one.- Since:
- 1.8
-
-