org.helenus.jackson.databind

Class ExtendedBeanProperty

java.lang.Object

org.helenus.jackson.databind.ExtendedBeanProperty

All Implemented Interfaces:

com.fasterxml.jackson.databind.BeanProperty, com.fasterxml.jackson.databind.util.Named

public class ExtendedBeanProperty
extends Object
implements com.fasterxml.jackson.databind.BeanProperty

The ExtendedBeanProperty class extends on Jackson's BeanProperty to provide support for querying repeatable annotations.

Since:

1.0

Version:

1 - Jul 21, 2016 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.BeanProperty

com.fasterxml.jackson.databind.BeanProperty.Std

Constructor Summary

Constructors

Constructor and Description
ExtendedBeanProperty(com.fasterxml.jackson.databind.BeanProperty bean) Instantiates a new ExtendedBeanProperty object.

Method Summary

Modifier and Type	Method and Description
void	depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor objectVisitor)
com.fasterxml.jackson.annotation.JsonFormat.Value	findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector intr)
<A extends Annotation> A	getAnnotation(Class<A> acls)
<A extends Annotation> A[]	getAnnotationByType(Class<A> acls) Method for finding annotations associated with this property; meaning annotations associated with one of entities used to access property.
com.fasterxml.jackson.databind.BeanProperty	getBean() Gets the underlying bean.
<A extends Annotation> A	getContextAnnotation(Class<A> acls)
<A extends Annotation> A[]	getContextAnnotationByType(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).
com.fasterxml.jackson.databind.PropertyName	getFullName()
com.fasterxml.jackson.databind.introspect.AnnotatedMember	getMember()
com.fasterxml.jackson.databind.PropertyMetadata	getMetadata()
String	getName()
com.fasterxml.jackson.databind.JavaType	getType()
com.fasterxml.jackson.databind.PropertyName	getWrapperName()
boolean	isRequired()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtendedBeanProperty

public ExtendedBeanProperty(com.fasterxml.jackson.databind.BeanProperty bean)

Instantiates a new ExtendedBeanProperty object.

Parameters:

bean - the bean to wrap and extend

Method Detail

getBean

public com.fasterxml.jackson.databind.BeanProperty getBean()

Gets the underlying bean.

Returns:

the non-null underlying bean

getName

public String getName()

Specified by:

getName in interface com.fasterxml.jackson.databind.BeanProperty

Specified by:

getName in interface com.fasterxml.jackson.databind.util.Named

See Also:

BeanProperty.getName()

getFullName

public com.fasterxml.jackson.databind.PropertyName getFullName()

Specified by:

getFullName in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getFullName()

getType

public com.fasterxml.jackson.databind.JavaType getType()

Specified by:

getType in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getType()

getWrapperName

public com.fasterxml.jackson.databind.PropertyName getWrapperName()

Specified by:

getWrapperName in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getWrapperName()

getMetadata

public com.fasterxml.jackson.databind.PropertyMetadata getMetadata()

Specified by:

getMetadata in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getMetadata()

isRequired

public boolean isRequired()

Specified by:

isRequired in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.isRequired()

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> acls)

Specified by:

getAnnotation in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getAnnotation(java.lang.Class)

getAnnotationByType

public <A extends Annotation> A[] getAnnotationByType(Class<A> acls)

Method for finding annotations associated with this property; meaning annotations associated with one of entities used to access property.

Note: This method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

The difference between this method and getAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation.

The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Parameters:

acls - the class object corresponding to the annotation type

Returns:

all this property's annotations for the specified annotation type if associated with this element, else an array of length zero

Throws:

NullPointerException - if the given annotation class is null

InternalError - if the annotation is repeatable but not defined properly

getContextAnnotation

public <A extends Annotation> A getContextAnnotation(Class<A> acls)

Specified by:

getContextAnnotation in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getContextAnnotation(java.lang.Class)

getContextAnnotationByType

public <A extends Annotation> A[] getContextAnnotationByType(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).

Note: This method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

The difference between this method and getContextAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation.

The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Parameters:

acls - the class object corresponding to the annotation type

Returns:

all this property's context annotations for the specified annotation type if associated with this element, else an array of length zero

Throws:

NullPointerException - if the given annotation class is null

InternalError - if the annotation is repeatable but not defined properly

getMember

public com.fasterxml.jackson.databind.introspect.AnnotatedMember getMember()

Specified by:

getMember in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.getMember()

findFormatOverrides

public com.fasterxml.jackson.annotation.JsonFormat.Value findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector intr)

Specified by:

findFormatOverrides in interface com.fasterxml.jackson.databind.BeanProperty

See Also:

BeanProperty.findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector)

depositSchemaProperty

public void depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor objectVisitor)
                           throws com.fasterxml.jackson.databind.JsonMappingException

Specified by:

depositSchemaProperty in interface com.fasterxml.jackson.databind.BeanProperty

Throws:

com.fasterxml.jackson.databind.JsonMappingException

See Also:

BeanProperty.depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()