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 implement Map, 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 final JavaType	_keyType	Type of keys of Map.
protected final JavaType	_valueType	Type of values of Map.

Fields inherited from class JavaType

_class, _hashCode, _typeHandler, _valueHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapLikeType(Class<?> mapType, JavaType keyT, JavaType valueT)	Deprecated.
protected	MapLikeType(Class<?> mapType, JavaType keyT, JavaType valueT, Object valueHandler, Object typeHandler)

Method Summary

Modifier and Type	Method	Description
protected JavaType	_narrow(Class<?> subclass)
protected String	buildCanonicalName()
static MapLikeType	construct(Class<?> rawType, JavaType keyT, JavaType valueT)
JavaType	containedType(int index)	Method for accessing definitions of contained ("child") types.
int	containedTypeCount()	Method for checking how many contained types this type has.
String	containedTypeName(int index)	Not sure if we should count on this, but type names for core interfaces are "K" and "V" respectively.
boolean	equals(Object o)
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)
StringBuilder	getErasedSignature(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.
StringBuilder	getGenericSignature(StringBuilder sb)
JavaType	getKeyType()	Method for accessing key type for this type, assuming type has such a concept (only Map types do)
boolean	isContainerType()
boolean	isMapLikeType()
boolean	isTrueMapType()	Method that can be used for checking whether this type is a "real" Collection type; meaning whether it represents a parameterized subtype of Collection or just something that acts like one.
JavaType	narrowContentsBy(Class<?> contentClass)
JavaType	narrowKey(Class<?> keySubclass)
String	toString()
JavaType	widenContentsBy(Class<?> contentClass)
JavaType	widenKey(Class<?> keySubclass)
MapLikeType	withContentTypeHandler(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.
MapLikeType	withContentValueHandler(Object h)
MapLikeType	withKeyTypeHandler(Object h)
MapLikeType	withKeyValueHandler(Object h)
MapLikeType	withTypeHandler(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.
MapLikeType	withValueHandler(Object h)

Methods inherited from class TypeBase

_classSignature, getTypeHandler, getValueHandler, serialize, serializeWithType, toCanonical

Methods inherited from class JavaType

_assertSubclass, _widen, forcedNarrowBy, getErasedSignature, getGenericSignature, getRawClass, hasGenericTypes, hashCode, hasRawClass, isAbstract, isArrayType, isCollectionLikeType, isConcrete, isEnumType, isFinal, isInterface, isPrimitive, isThrowable, narrowBy, setValueHandler, widenBy

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_keyType

protected final JavaType _keyType

Type of keys of Map.

_valueType

protected final JavaType _valueType

Type of values of Map.

Constructor Details

MapLikeType

@Deprecated
protected MapLikeType(Class<?> mapType,
 JavaType keyT,
 JavaType valueT)

Deprecated.

MapLikeType

protected MapLikeType(Class<?> mapType,
 JavaType keyT,
 JavaType valueT,
 Object valueHandler,
 Object typeHandler)

Method Details

construct

public static MapLikeType construct(Class<?> rawType,
 JavaType keyT,
 JavaType valueT)

_narrow

protected JavaType _narrow(Class<?> subclass)

Specified by:

_narrow in class JavaType

narrowContentsBy

public JavaType narrowContentsBy(Class<?> contentClass)

Specified by:

narrowContentsBy in class JavaType

widenContentsBy

public JavaType widenContentsBy(Class<?> contentClass)

Specified by:

widenContentsBy in class JavaType

narrowKey

public JavaType narrowKey(Class<?> keySubclass)

widenKey

public JavaType widenKey(Class<?> keySubclass)

Since:

1.8

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:

withTypeHandler in class JavaType

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:

withContentTypeHandler in class JavaType

Returns:

Newly created type instance

withValueHandler

public MapLikeType withValueHandler(Object h)

Overrides:

withValueHandler in class JavaType

withContentValueHandler

public MapLikeType withContentValueHandler(Object h)

Overrides:

withContentValueHandler in class JavaType

buildCanonicalName

protected String buildCanonicalName()

Specified by:

buildCanonicalName in class TypeBase

isContainerType

public boolean isContainerType()

Specified by:

isContainerType in class JavaType

Returns:

True if type represented is a container type; this includes array, Map and Collection types.

isMapLikeType

public boolean isMapLikeType()

Overrides:

isMapLikeType in class JavaType

Returns:

True if type is either true Map type, 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: JavaType

Method for accessing key type for this type, assuming type has such a concept (only Map types do)

Overrides:

getKeyType in class JavaType

getContentType

public JavaType getContentType()

Description copied from class: JavaType

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 class JavaType

containedTypeCount

public int containedTypeCount()

Description copied from class: JavaType

Method for checking how many contained types this type has. Contained types are usually generic types, so that generic Maps have 2 contained types.

Overrides:

containedTypeCount in class JavaType

containedType

public JavaType containedType(int index)

Description copied from class: JavaType

Method for accessing definitions of contained ("child") types.

Overrides:

containedType in class JavaType

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:

containedTypeName in class JavaType

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: 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 class TypeBase

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:

getGenericSignature in class TypeBase

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 of Collection or just something that acts like one.

Since:

1.8

toString

public String toString()

Specified by:

toString in class JavaType

equals

public boolean equals(Object o)

Specified by:

equals in class JavaType