public interface BeanProperty extends Named
Instances are not typically passed when constructing serializers
and deserializers, but rather only passed when context
is known when
ContextualSerializer
and
ContextualDeserializer
resolution occurs (createContextual(...)
method is called).
References may (need to) be retained by serializers and deserializers,
especially when further resolving dependant handlers like value
serializers/deserializers or structured types.
Modifier and Type | Interface and Description |
---|---|
static class |
BeanProperty.Std
Simple stand-alone implementation, useful as a placeholder
or base class for more complex implementations.
|
Modifier and Type | Method and Description |
---|---|
void |
depositSchemaProperty(JsonObjectFormatVisitor objectVisitor)
Method that can be called to visit the type structure that this
property is part of.
|
<A extends Annotation> |
getAnnotation(Class<A> acls)
Method for finding annotation associated with this property;
meaning annotation associated with one of entities used to
access property.
|
<A extends Annotation> |
getContextAnnotation(Class<A> acls)
Method for finding annotation associated with context of
this property; usually class in which member is declared
(or its subtype if processing subtype).
|
PropertyName |
getFullName()
Method for getting full name definition, including possible
format-specific additional properties (such as namespace when
using XML backend).
|
AnnotatedMember |
getMember()
Method for accessing primary physical entity that represents the property;
annotated field, method or constructor property.
|
PropertyMetadata |
getMetadata()
Accessor for additional optional information about property.
|
String |
getName()
Method to get logical name of the property
|
JavaType |
getType()
Method to get declared type of the property.
|
PropertyName |
getWrapperName()
If property is indicated to be wrapped, name of
wrapper element to use.
|
boolean |
isRequired()
Whether value for property is marked as required using
annotations or associated schema.
|
String getName()
PropertyName getFullName()
JavaType getType()
PropertyName getWrapperName()
PropertyMetadata getMetadata()
boolean isRequired()
getMetadata().isRequired()
<A extends Annotation> A getAnnotation(Class<A> acls)
<A extends Annotation> A getContextAnnotation(Class<A> acls)
AnnotatedMember getMember()
void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor) throws JsonMappingException
UnsupportedOperationException
.objectVisitor
- Visitor to used as the callback handlerJsonMappingException
Copyright © 2016 JBoss by Red Hat. All rights reserved.