public static class BeanProperty.Std extends Object implements BeanProperty
BeanProperty.Std
Modifier and Type | Field and Description |
---|---|
protected Annotations |
_contextAnnotations
Annotations defined in the context class (if any); may be null
if no annotations were found
|
protected AnnotatedMember |
_member
Physical entity (field, method or constructor argument) that
is used to access value of property (or in case of constructor
property, just placeholder)
|
protected PropertyMetadata |
_metadata |
protected PropertyName |
_name |
protected JavaType |
_type |
protected PropertyName |
_wrapperName |
EMPTY_FORMAT, EMPTY_INCLUDE
Constructor and Description |
---|
BeanProperty.Std(BeanProperty.Std base,
JavaType newType) |
BeanProperty.Std(PropertyName name,
JavaType type,
PropertyName wrapperName,
Annotations contextAnnotations,
AnnotatedMember member,
PropertyMetadata metadata) |
BeanProperty.Std(String name,
JavaType type,
PropertyName wrapperName,
Annotations contextAnnotations,
AnnotatedMember member,
boolean isRequired)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
SerializerProvider provider)
Implementation of this method throws
UnsupportedOperationException , since instances of this
implementation should not be used as part of actual structure
visited. |
JsonFormat.Value |
findFormatOverrides(AnnotationIntrospector intr)
Deprecated.
|
JsonFormat.Value |
findPropertyFormat(MapperConfig<?> config,
Class<?> baseType)
Helper method used to look up format settings applicable to this property,
considering both possible per-type configuration settings
|
JsonInclude.Value |
findPropertyInclusion(MapperConfig<?> config,
Class<?> baseType)
Convenience method that is roughly equivalent to
|
<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.
|
boolean |
isVirtual()
TODO: move to
BeanProperty in near future, once all standard
implementations define it. |
BeanProperty.Std |
withType(JavaType type) |
protected final PropertyName _name
protected final JavaType _type
protected final PropertyName _wrapperName
protected final PropertyMetadata _metadata
protected final AnnotatedMember _member
protected final Annotations _contextAnnotations
public BeanProperty.Std(PropertyName name, JavaType type, PropertyName wrapperName, Annotations contextAnnotations, AnnotatedMember member, PropertyMetadata metadata)
public BeanProperty.Std(BeanProperty.Std base, JavaType newType)
@Deprecated public BeanProperty.Std(String name, JavaType type, PropertyName wrapperName, Annotations contextAnnotations, AnnotatedMember member, boolean isRequired)
public BeanProperty.Std withType(JavaType type)
public <A extends Annotation> A getAnnotation(Class<A> acls)
BeanProperty
Note that this method should only be called for custom annotations;
access to standard Jackson annotations (or ones supported by
alternate AnnotationIntrospector
s) should be accessed
through AnnotationIntrospector
.
getAnnotation
in interface BeanProperty
public <A extends Annotation> A getContextAnnotation(Class<A> acls)
BeanProperty
Note that this method should only be called for custom annotations;
access to standard Jackson annotations (or ones supported by
alternate AnnotationIntrospector
s) should be accessed
through AnnotationIntrospector
.
getContextAnnotation
in interface BeanProperty
@Deprecated public JsonFormat.Value findFormatOverrides(AnnotationIntrospector intr)
BeanProperty
return intr.findFormat(getMember());and specifically does NOT try to find per-type format defaults to merge; use
BeanProperty.findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)
if such defaults would be useful.findFormatOverrides
in interface BeanProperty
public JsonFormat.Value findPropertyFormat(MapperConfig<?> config, Class<?> baseType)
BeanProperty
findPropertyFormat
in interface BeanProperty
public JsonInclude.Value findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)
BeanProperty
return config.getAnnotationIntrospector().findPropertyInclusion(getMember());but also considers global default settings for inclusion
findPropertyInclusion
in interface BeanProperty
public String getName()
BeanProperty
getName
in interface BeanProperty
getName
in interface Named
public PropertyName getFullName()
BeanProperty
getFullName
in interface BeanProperty
public JavaType getType()
BeanProperty
getType
in interface BeanProperty
public PropertyName getWrapperName()
BeanProperty
getWrapperName
in interface BeanProperty
public boolean isRequired()
BeanProperty
getMetadata().isRequired()
isRequired
in interface BeanProperty
public PropertyMetadata getMetadata()
BeanProperty
getMetadata
in interface BeanProperty
public AnnotatedMember getMember()
BeanProperty
getMember
in interface BeanProperty
public boolean isVirtual()
TODO: move to BeanProperty
in near future, once all standard
implementations define it.
isVirtual
in interface BeanProperty
public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider)
UnsupportedOperationException
, since instances of this
implementation should not be used as part of actual structure
visited. Rather, other implementations should handle it.depositSchemaProperty
in interface BeanProperty
objectVisitor
- Visitor to used as the callback handlerCopyright © 2008–2016 FasterXML. All rights reserved.