|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.core.convert.TypeDescriptor
public class TypeDescriptor
Context about a type to convert to.
Field Summary | |
---|---|
static TypeDescriptor |
NULL
Constant defining a TypeDescriptor for a null value |
Constructor Summary | |
---|---|
TypeDescriptor(Field field)
Create a new type descriptor for a field. |
|
TypeDescriptor(Field field,
Class<?> type)
Create a new type descriptor for a field. |
|
TypeDescriptor(MethodParameter methodParameter)
Create a new type descriptor from a method or constructor parameter. |
|
TypeDescriptor(MethodParameter methodParameter,
Class<?> type)
Create a new type descriptor from a method or constructor parameter. |
Method Summary | |
---|---|
String |
asString()
A textual representation of the type descriptor (eg. |
boolean |
equals(Object obj)
|
TypeDescriptor |
forElementType(Class<?> elementType)
Create a copy of this type descriptor, preserving the context information but exposing the specified element type (e.g. |
static TypeDescriptor |
forObject(Object object)
Create a new type descriptor for the class of the given object. |
Annotation |
getAnnotation(Class<? extends Annotation> annotationType)
Obtain the annotation associated with the wrapped parameter/field, if any. |
Annotation[] |
getAnnotations()
Obtain the annotations associated with the wrapped parameter/field, if any. |
Class<?> |
getElementType()
If this type is an array type or Collection type, returns the underlying element type. |
TypeDescriptor |
getElementTypeDescriptor()
Return the element type as a type descriptor. |
TypeDescriptor |
getElementTypeDescriptor(Object element)
Return the element type as a type descriptor. |
Field |
getField()
Return the wrapped Field, if any. |
Class<?> |
getMapKeyType()
Determine the generic key type of the wrapped Map parameter/field, if any. |
TypeDescriptor |
getMapKeyTypeDescriptor()
Returns map key type as a type descriptor. |
TypeDescriptor |
getMapKeyTypeDescriptor(Object key)
Return the map key type as a type descriptor. |
Class<?> |
getMapValueType()
Determine the generic value type of the wrapped Map parameter/field, if any. |
TypeDescriptor |
getMapValueTypeDescriptor()
Returns map value type as a type descriptor. |
TypeDescriptor |
getMapValueTypeDescriptor(Object value)
Return the map value type as a type descriptor. |
MethodParameter |
getMethodParameter()
Return the wrapped MethodParameter, if any. |
String |
getName()
Returns the name of this type: the fully qualified class name. |
Class<?> |
getObjectType()
Determine the declared type of the wrapped parameter/field. |
Class<?> |
getType()
Determine the declared (non-generic) type of the wrapped parameter/field. |
int |
hashCode()
|
boolean |
isArray()
Is this type an array type? |
boolean |
isAssignableTo(TypeDescriptor targetType)
Returns true if an object of this type can be assigned to a reference of given targetType. |
boolean |
isCollection()
Is this type a Collection type? |
boolean |
isMap()
Is this type a Map type? |
boolean |
isMapEntryTypeKnown()
Is this descriptor for a map where the key type and value type are known? |
boolean |
isPrimitive()
Is this type a primitive type? |
String |
toString()
|
static TypeDescriptor |
valueOf(Class<?> type)
Create a new type descriptor for the given class. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final TypeDescriptor NULL
null
value
Constructor Detail |
---|
public TypeDescriptor(MethodParameter methodParameter)
Use this constructor when a target conversion point originates from a method parameter, such as a setter method argument.
methodParameter
- the MethodParameter to wrappublic TypeDescriptor(Field field)
field
- the field to wrappublic TypeDescriptor(MethodParameter methodParameter, Class<?> type)
Use this constructor when a target conversion point originates from a method parameter, such as a setter method argument.
methodParameter
- the MethodParameter to wraptype
- the specific type to expose (may be an array/collection element)public TypeDescriptor(Field field, Class<?> type)
field
- the field to wraptype
- the specific type to expose (may be an array/collection element)Method Detail |
---|
public MethodParameter getMethodParameter()
Note: Either MethodParameter or Field is available.
null
if nonepublic Field getField()
Note: Either MethodParameter or Field is available.
null
if nonepublic Class<?> getType()
null
if this is NULL
public Class<?> getObjectType()
public String getName()
public boolean isPrimitive()
public boolean isArray()
public boolean isCollection()
Collection
type?
public Class<?> getElementType()
Collection
type, returns the underlying element type.
Returns null
if the type is neither an array or collection.
public TypeDescriptor getElementTypeDescriptor()
public TypeDescriptor getElementTypeDescriptor(Object element)
element
- the element
public boolean isMap()
Map
type?
public boolean isMapEntryTypeKnown()
public Class<?> getMapKeyType()
null
if nonepublic TypeDescriptor getMapKeyTypeDescriptor()
public TypeDescriptor getMapKeyTypeDescriptor(Object key)
key
- the key
public Class<?> getMapValueType()
null
if nonepublic TypeDescriptor getMapValueTypeDescriptor()
public TypeDescriptor getMapValueTypeDescriptor(Object value)
value
- the value
public Annotation[] getAnnotations()
public Annotation getAnnotation(Class<? extends Annotation> annotationType)
public boolean isAssignableTo(TypeDescriptor targetType)
targetType
- the target type
public TypeDescriptor forElementType(Class<?> elementType)
elementType
- the desired type to expose
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String asString()
public String toString()
toString
in class Object
public static TypeDescriptor forObject(Object object)
object
- the object
public static TypeDescriptor valueOf(Class<?> type)
type
- the class
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |