Package com.oracle.coherence.io.json.genson.reflect

Class BeanMutatorAccessorResolver.AnnotationPropertyResolver

java.lang.Object

com.oracle.coherence.io.json.genson.reflect.BeanMutatorAccessorResolver.AnnotationPropertyResolver

All Implemented Interfaces:

BeanMutatorAccessorResolver

Direct Known Subclasses:

BeanMutatorAccessorResolver.GensonAnnotationPropertyResolver

Enclosing interface:

BeanMutatorAccessorResolver

public static class BeanMutatorAccessorResolver.AnnotationPropertyResolver
extends Object
implements BeanMutatorAccessorResolver

A basic Annotation scanning BeanMutatorAccessorResolver assuming the use of three primary Annotations:

• propertyAnnotation: an annotation, such as JsonProperty, denoting a property to serialize/deserialize.
• exclusionAnnotation: an annotation, such as JsonIgnore denoting an exclusion of a property from serialization/deserialization.
• creatorAnnotation: an annotation, such as JsonCreator denoting a constructor or factory method to use when deserializing an entity.

Since:

1.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.coherence.io.json.genson.reflect.BeanMutatorAccessorResolver

BeanMutatorAccessorResolver.AnnotationPropertyResolver, BeanMutatorAccessorResolver.CompositeResolver, BeanMutatorAccessorResolver.GensonAnnotationPropertyResolver, BeanMutatorAccessorResolver.PropertyBaseResolver, BeanMutatorAccessorResolver.StandardMutaAccessorResolver

Field Summary

Fields

Modifier and Type	Field	Description
protected Class<? extends Annotation>	creatorAnnotation	An Annotation that functions similarly to JsonCreator.
protected Class<? extends Annotation>	exclusionAnnotation	An Annotation that functions similarly to JsonIgnore.
protected Class<? extends Annotation>	propertyAnnotation	An Annotation that functions similarly to JsonProperty.

Constructor Summary

Constructors

Constructor	Description
AnnotationPropertyResolver(Class<? extends Annotation> propertyAnnotation, Class<? extends Annotation> exclusionAnnotation, Class<? extends Annotation> creatorAnnotation)	Create a new resolver for the specified annotations.

Method Summary

Modifier and Type	Method	Description
protected <A extends Annotation> A	find(Class<A> annotation, Class<?> onClass)	Scan for the argument Annotation on the argument Class.
protected <A extends Annotation> A	find(Class<A> annotation, Class<?> inClass, String methodName, Class<?>... parameterTypes)	Scan for the argument Annotation on a method matching the argument method names and parameters.
protected <A extends Annotation> A	find(Class<A> annotation, AccessibleObject onObject, Class<?> onClass)	Scan for the argument Annotation on the argument AccessibleObject.
protected String	getGetterName(Method method)	Return the property name based on argument Method.
protected String	getSetterName(Method method)	Return the property name based on argument Method.
protected boolean	ignore(AccessibleObject property, Class<?> ofType, boolean forSerialization)	Scans for the presence of the exclusionAnnotation/
protected boolean	include(AccessibleObject property, Class<?> ofType, boolean forSerialization)	Scans for the presence of the propertyAnnotation.
Trilean	isAccessor(Field field, Class<?> fromClass)	Determines if the configured propertyAnnotation is present on the provided Field.
Trilean	isAccessor(Method method, Class<?> fromClass)	Determines if the configured propertyAnnotation is present on the provided Field.
Trilean	isCreator(Constructor<?> constructor, Class<?> fromClass)	Determines if the configured creatorAnnotation is present on the provided Constructor.
Trilean	isCreator(Method method, Class<?> fromClass)	Determines if the configured creatorAnnotation is present on the provided Method.
boolean	isCreatorAnnotated(Constructor<?> constructor)
boolean	isCreatorAnnotated(Method method)
Trilean	isMutator(Field field, Class<?> fromClass)	Determines if the configured propertyAnnotation is present on the provided Field.
Trilean	isMutator(Method method, Class<?> fromClass)	Determines if the configured propertyAnnotation is present on the provided Field.

Methods inherited from class java.lang.Object

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

Field Detail

propertyAnnotation

protected Class<? extends Annotation> propertyAnnotation

An Annotation that functions similarly to JsonProperty.

exclusionAnnotation

protected Class<? extends Annotation> exclusionAnnotation

An Annotation that functions similarly to JsonIgnore.

creatorAnnotation

protected Class<? extends Annotation> creatorAnnotation

An Annotation that functions similarly to JsonCreator. This value may be null.

Constructor Detail

AnnotationPropertyResolver

public AnnotationPropertyResolver(Class<? extends Annotation> propertyAnnotation,
                                  Class<? extends Annotation> exclusionAnnotation,
                                  Class<? extends Annotation> creatorAnnotation)

Create a new resolver for the specified annotations. The notion of property, exclusion, and creator will be carried forward in the documentation of the class.

Parameters:

propertyAnnotation -

exclusionAnnotation -

creatorAnnotation -

Method Detail

isCreator

public Trilean isCreator(Constructor<?> constructor,
                         Class<?> fromClass)

Determines if the configured creatorAnnotation is present on the provided Constructor.

Specified by:

isCreator in interface BeanMutatorAccessorResolver

Parameters:

constructor - the Constructor to scan

fromClass - the Class the Constructor is associated with

Returns:

Trilean.TRUE if the creatorAnnotation is found, otherwise Trilean.UNKNOWN

isCreator

public Trilean isCreator(Method method,
                         Class<?> fromClass)

Determines if the configured creatorAnnotation is present on the provided Method.

Specified by:

isCreator in interface BeanMutatorAccessorResolver

Parameters:

method - the Method to scan

fromClass - the Class the Method is associated with

Returns:

Trilean.TRUE if the creatorAnnotation is found, otherwise Trilean.UNKNOWN

Throws:

JsonBindingException - if the annotated Method is not public and static

isCreatorAnnotated

public boolean isCreatorAnnotated(Constructor<?> constructor)

Specified by:

isCreatorAnnotated in interface BeanMutatorAccessorResolver

isCreatorAnnotated

public boolean isCreatorAnnotated(Method method)

Specified by:

isCreatorAnnotated in interface BeanMutatorAccessorResolver

isAccessor

public Trilean isAccessor(Field field,
                          Class<?> fromClass)

Determines if the configured propertyAnnotation is present on the provided Field. Invoked during serialization.

Specified by:

isAccessor in interface BeanMutatorAccessorResolver

Parameters:

field - the Field to scan

fromClass - the Class the Field is associated with

Returns:

Trilean.FALSE if the Field is annotated with the exclusionAnnotation, Trilean.TRUE if the propertyAnnotation is found, otherwise returns Trilean.UNKNOWN

isAccessor

public Trilean isAccessor(Method method,
                          Class<?> fromClass)

Determines if the configured propertyAnnotation is present on the provided Field. Invoked during serialization.

Specified by:

isAccessor in interface BeanMutatorAccessorResolver

Parameters:

method - the Method to scan

fromClass - the Class the Field is associated with

Returns:

Trilean.FALSE if the Method is annotated with the exclusionAnnotation, Trilean.TRUE if the propertyAnnotation is found, otherwise returns Trilean.UNKNOWN

isMutator

public Trilean isMutator(Field field,
                         Class<?> fromClass)

Determines if the configured propertyAnnotation is present on the provided Field. Invoked during deserialization.

Specified by:

isMutator in interface BeanMutatorAccessorResolver

Parameters:

field - the Field to scan

fromClass - the Class the Field is associated with

Returns:

Trilean.FALSE if the Field is annotated with the exclusionAnnotation, Trilean.TRUE if the propertyAnnotation is found, otherwise returns Trilean.UNKNOWN

isMutator

public Trilean isMutator(Method method,
                         Class<?> fromClass)

Determines if the configured propertyAnnotation is present on the provided Field. Invoked during serialization.

Specified by:

isMutator in interface BeanMutatorAccessorResolver

Parameters:

method - the Method to scan

fromClass - the Class the Field is associated with

Returns:

Trilean.FALSE if the Method is annotated with the exclusionAnnotation, Trilean.TRUE if the propertyAnnotation is found, otherwise returns Trilean.UNKNOWN

getGetterName

protected String getGetterName(Method method)

Return the property name based on argument Method. This assumes a getter using standard Java Beans naming conventions.

Parameters:

method - the Method to extract the name from

Returns:

the property name or null if the method isn't a getter.

getSetterName

protected String getSetterName(Method method)

Return the property name based on argument Method. This assumes a setter using standard Java Beans naming conventions.

Parameters:

method - the Method to extract the name from

Returns:

the property name or null if the method isn't a setter.

ignore

protected boolean ignore(AccessibleObject property,
                         Class<?> ofType,
                         boolean forSerialization)

Scans for the presence of the exclusionAnnotation/

Parameters:

property - the property to scan

ofType - the associated Class

forSerialization - flag indicating if this exclusion check is for a serialization or deserialization operation

Returns:

true if the Annotation is found, otherwise false

include

protected boolean include(AccessibleObject property,
                          Class<?> ofType,
                          boolean forSerialization)

Scans for the presence of the propertyAnnotation.

Parameters:

property - the property to scan

ofType - the associated Class

forSerialization - flag indicating if this exclusion check is for a serialization or deserialization operation

Returns:

true if the Annotation is found, otherwise false

find

protected <A extends Annotation> A find(Class<A> annotation,
                                        AccessibleObject onObject,
                                        Class<?> onClass)

Scan for the argument Annotation on the argument AccessibleObject.

Parameters:

annotation - the Annotation to scan for

onObject - the entity that may be annotated with the specified Annotation

onClass - the Class associated with the AccessibleObject

Returns:

the Annotation if found, otherwise returns null

find

protected <A extends Annotation> A find(Class<A> annotation,
                                        Class<?> onClass)

Scan for the argument Annotation on the argument Class.

Parameters:

annotation - the Annotation to scan for

onClass - the Class to scan

Returns:

the Annotation if found, otherwise returns null

find

protected <A extends Annotation> A find(Class<A> annotation,
                                        Class<?> inClass,
                                        String methodName,
                                        Class<?>... parameterTypes)

Scan for the argument Annotation on a method matching the argument method names and parameters.

Parameters:

annotation - the Annotation to scan for

inClass - the Class to search for a matching method

methodName - the method's name

parameterTypes - the method's argument types

Returns:

the Annotation if found, otherwise returns null