AnnotationIntrospector (org.eclipse.yasson 1.0.2 API)

java.lang.Object
- org.eclipse.yasson.internal.AnnotationIntrospector

```
public class AnnotationIntrospector
extends Object
```
Introspects configuration on classes and their properties by reading annotations.

Author:

Roman Grigoriadi

Field Summary

Fields
Modifier and Type Field Description

static List<Class<? extends Annotation>> TRANSIENT_INCOMPATIBLE
Annotations to report exception when used in combination with JsonbTransient

Fields
Modifier and Type	Field	Description
`static List<Class<? extends Annotation>>`	`TRANSIENT_INCOMPATIBLE`	Annotations to report exception when used in combination with `JsonbTransient`

Constructor Summary

Constructors
Constructor Description

AnnotationIntrospector(JsonbContext jsonbContext)
Creates annotation introspecting component passing JsonbContext inside.

Constructors
Constructor	Description
`AnnotationIntrospector(JsonbContext jsonbContext)`	Creates annotation introspecting component passing `JsonbContext` inside.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkTransientIncompatible(JsonbAnnotatedElement<?> target)`	Finds annotations incompatible with `JsonbTransient` annotation.
`JsonbAnnotatedElement<Class<?>>`	`collectAnnotations(Class<?> clazz)`	Collect annotations of given class, its interfaces and the package.
`Set<Class<?>>`	`collectInterfaces(Class<?> cls)`	Get class interfaces recursively.
`AdapterBinding`	`getAdapterBinding(JsonbAnnotatedElement<Class<?>> clsElement)`	Checks for `JsonbAdapter` on a type.
`AdapterBinding`	`getAdapterBinding(Property property)`	Checks for `JsonbAdapter` on a property.
`JsonbDateFormatter`	`getConstructorDateFormatter(JsonbAnnotatedElement<Parameter> param)`
`JsonbNumberFormatter`	`getConstructorNumberFormatter(JsonbAnnotatedElement<Parameter> param)`
`JsonbCreator`	`getCreator(Class<?> clazz)`	Searches for JsonbCreator annotation on constructors and static methods.
`DeserializerBinding`	`getDeserializerBinding(JsonbAnnotatedElement<Class<?>> clsElement)`	Checks for `JsonbDeserializer` on a type.
`DeserializerBinding`	`getDeserializerBinding(Property property)`	Checks for `JsonbDeserializer` on a property.
`Class<?>`	`getImplementationClass(Property property)`
`JsonbDateFormatter`	`getJsonbDateFormat(JsonbAnnotatedElement<Class<?>> clazzElement)`	Search for `JsonbDateFormat` annotation on java class and construct `JsonbDateFormatter`.
`Map<AnnotationTarget,JsonbDateFormatter>`	`getJsonbDateFormatCategorized(Property property)`	Search `JsonbDateFormat` on property, if not found looks at annotations declared on property type class.
`JsonbNumberFormatter`	`getJsonbNumberFormat(JsonbAnnotatedElement<Class<?>> clazzElement)`	Search for `JsonbNumberFormat` annotation on java class.
`String`	`getJsonbPropertyJsonReadName(Property property)`	Gets a name of property for JSON unmarshalling.
`String`	`getJsonbPropertyJsonWriteName(Property property)`	Gets a name of property for JSON marshalling.
`EnumSet<AnnotationTarget>`	`getJsonbTransientCategorized(Property property)`	Checks if property is annotated transient.
`Map<AnnotationTarget,JsonbNumberFormatter>`	`getJsonNumberFormatter(Property property)`	Search `JsonbNumberFormat` on property, if not found looks at annotations declared on property type class.
`String[]`	`getPropertyOrder(JsonbAnnotatedElement<Class<?>> clazzElement)`	Checks for `JsonbPropertyOrder` annotation.
`Optional<javax.json.bind.config.PropertyVisibilityStrategy>`	`getPropertyVisibilityStrategy(Class<?> clazz)`	Get a @JsonbVisibility annotation from a class or its package.
`SerializerBinding`	`getSerializerBinding(JsonbAnnotatedElement<Class<?>> clsElement)`	Checks for `JsonbSerializer` on a type.
`SerializerBinding`	`getSerializerBinding(Property property)`	Checks for `JsonbSerializer` on a property.
`ClassCustomization`	`introspectCustomization(JsonbAnnotatedElement<Class<?>> clsElement)`	Processes customizations.
`boolean`	`isClassNillable(JsonbAnnotatedElement<Class<?>> clazzElement)`	Checks for JsonbNillable annotation on a class, its superclasses and interfaces.
`Optional<Boolean>`	`isPropertyNillable(Property property)`	Checks if property is nillable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRANSIENT_INCOMPATIBLE
```
public static final List<Class<? extends Annotation>> TRANSIENT_INCOMPATIBLE
```
    Annotations to report exception when used in combination with JsonbTransient
- Constructor Detail
  - AnnotationIntrospector
```
public AnnotationIntrospector(JsonbContext jsonbContext)
```
    Creates annotation introspecting component passing JsonbContext inside.
    
    Parameters:
    
    jsonbContext - mandatory
- Method Detail
  - getJsonbPropertyJsonWriteName
```
public String getJsonbPropertyJsonWriteName(Property property)
```
    Gets a name of property for JSON marshalling. Can be different writeName for same property.
    
    Parameters:
    
    property - property representation - field, getter, setter (not null)
    
    Returns:
    
    read name
  - getJsonbPropertyJsonReadName
```
public String getJsonbPropertyJsonReadName(Property property)
```
    Gets a name of property for JSON unmarshalling. Can be different from writeName for same property.
    
    Parameters:
    
    property - property representation - field, getter, setter (not null)
    
    Returns:
    
    write name
  - getCreator
```
public JsonbCreator getCreator(Class<?> clazz)
```
    Searches for JsonbCreator annotation on constructors and static methods.
    
    Parameters:
    
    clazz - class to search
    
    Returns:
    
    JsonbCreator metadata object
  - getAdapterBinding
```
public AdapterBinding getAdapterBinding(Property property)
```
    Checks for JsonbAdapter on a property.
    
    Parameters:
    
    property - property not null
    
    Returns:
    
    components info
  - getAdapterBinding
```
public AdapterBinding getAdapterBinding(JsonbAnnotatedElement<Class<?>> clsElement)
```
    Checks for JsonbAdapter on a type.
    
    Parameters:
    
    clsElement - type not null
    
    Returns:
    
    components info
  - getDeserializerBinding
```
public DeserializerBinding getDeserializerBinding(Property property)
```
    Checks for JsonbDeserializer on a property.
    
    Parameters:
    
    property - property not null
    
    Returns:
    
    components info
  - getDeserializerBinding
```
public DeserializerBinding getDeserializerBinding(JsonbAnnotatedElement<Class<?>> clsElement)
```
    Checks for JsonbDeserializer on a type.
    
    Parameters:
    
    clsElement - type not null
    
    Returns:
    
    components info
  - getSerializerBinding
```
public SerializerBinding getSerializerBinding(Property property)
```
    Checks for JsonbSerializer on a property.
    
    Parameters:
    
    property - property not null
    
    Returns:
    
    components info
  - getSerializerBinding
```
public SerializerBinding getSerializerBinding(JsonbAnnotatedElement<Class<?>> clsElement)
```
    Checks for JsonbSerializer on a type.
    
    Parameters:
    
    clsElement - type not null
    
    Returns:
    
    components info
  - isPropertyNillable
```
public Optional<Boolean> isPropertyNillable(Property property)
```
    Checks if property is nillable. Looks for JsonbProperty nillable attribute only. JsonbNillable is checked only for ClassModels.
    
    Parameters:
    
    property - property to search in, not null
    
    Returns:
    
    True if property should be serialized when null.
  - isClassNillable
```
public boolean isClassNillable(JsonbAnnotatedElement<Class<?>> clazzElement)
```
    Checks for JsonbNillable annotation on a class, its superclasses and interfaces.
    
    Parameters:
    
    clazzElement - class to search JsonbNillable in.
    
    Returns:
    
    true if found
  - getPropertyOrder
```
public String[] getPropertyOrder(JsonbAnnotatedElement<Class<?>> clazzElement)
```
    Checks for JsonbPropertyOrder annotation.
    
    Parameters:
    
    clazzElement - class to search on
    
    Returns:
    
    ordered properties names or null if not found
  - getJsonbTransientCategorized
```
public EnumSet<AnnotationTarget> getJsonbTransientCategorized(Property property)
```
    Checks if property is annotated transient. If JsonbTransient annotation is present on field getter or setter, and other annotation is present on either of it, JsonbException is thrown with message describing collision.
    
    Parameters:
    
    property - The property to inspect if there is any JsonbTransient annotation defined for it
    
    Returns:
    
    Set of AnnotationTargets specifying in which scope the JsonbTransient is applied
  - getJsonbDateFormatCategorized
```
public Map<AnnotationTarget,JsonbDateFormatter> getJsonbDateFormatCategorized(Property property)
```
    Search JsonbDateFormat on property, if not found looks at annotations declared on property type class.
    
    Parameters:
    
    property - Property to search on.
    
    Returns:
    
    Map of JsonbDateFormatter instances categorized by their scopes (class, property, getter or setter). If there is no date formatter specified for given property, an empty map would be returned
  - getJsonbDateFormat
```
public JsonbDateFormatter getJsonbDateFormat(JsonbAnnotatedElement<Class<?>> clazzElement)
```
    Search for JsonbDateFormat annotation on java class and construct JsonbDateFormatter. If not found looks at annotations declared on property type class.
    
    Parameters:
    
    clazzElement - class to search not null
    
    Returns:
    
    formatter to use
  - getJsonbNumberFormat
```
public JsonbNumberFormatter getJsonbNumberFormat(JsonbAnnotatedElement<Class<?>> clazzElement)
```
    Search for JsonbNumberFormat annotation on java class.
    
    Parameters:
    
    clazzElement - class to search not null
    
    Returns:
    
    formatter to use
  - getJsonNumberFormatter
```
public Map<AnnotationTarget,JsonbNumberFormatter> getJsonNumberFormatter(Property property)
```
    Search JsonbNumberFormat on property, if not found looks at annotations declared on property type class.
    
    Parameters:
    
    property - Property to search on.
    
    Returns:
    
    Map of JsonbNumberFormatter instances categorized by their scopes (class, property, getter or setter). If there is no number formatter specified for given property, an empty map would be returned
  - getConstructorNumberFormatter
```
public JsonbNumberFormatter getConstructorNumberFormatter(JsonbAnnotatedElement<Parameter> param)
```
  - getConstructorDateFormatter
```
public JsonbDateFormatter getConstructorDateFormatter(JsonbAnnotatedElement<Parameter> param)
```
  - getPropertyVisibilityStrategy
```
public Optional<javax.json.bind.config.PropertyVisibilityStrategy> getPropertyVisibilityStrategy(Class<?> clazz)
```
    Get a @JsonbVisibility annotation from a class or its package.
    
    Parameters:
    
    clazz - Class to lookup annotation
    
    Returns:
    
    Instantiated PropertyVisibilityStrategy if annotation is present
  - checkTransientIncompatible
```
public void checkTransientIncompatible(JsonbAnnotatedElement<?> target)
```
    Finds annotations incompatible with JsonbTransient annotation.
    
    Parameters:
    
    target - target to check
    
    Throws:
    
    javax.json.bind.JsonbException - If incompatible annotation is found.
  - collectInterfaces
```
public Set<Class<?>> collectInterfaces(Class<?> cls)
```
    Get class interfaces recursively.
    
    Parameters:
    
    cls - Class to process.
    
    Returns:
    
    A list of all class interfaces.
  - introspectCustomization
```
public ClassCustomization introspectCustomization(JsonbAnnotatedElement<Class<?>> clsElement)
```
    Processes customizations.
    
    Parameters:
    
    clsElement - Element to process.
    
    Returns:
    
    Populated ClassCustomization instance.
  - getImplementationClass
```
public Class<?> getImplementationClass(Property property)
```
  - collectAnnotations
```
public JsonbAnnotatedElement<Class<?>> collectAnnotations(Class<?> clazz)
```
    Collect annotations of given class, its interfaces and the package.
    
    Parameters:
    
    clazz - Class to process.
    
    Returns:
    
    Element with class and annotations.

Class AnnotationIntrospector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRANSIENT_INCOMPATIBLE

Constructor Detail

AnnotationIntrospector

Method Detail

getJsonbPropertyJsonWriteName

getJsonbPropertyJsonReadName

getCreator

getAdapterBinding

getAdapterBinding

getDeserializerBinding

getDeserializerBinding

getSerializerBinding

getSerializerBinding

isPropertyNillable

isClassNillable

getPropertyOrder

getJsonbTransientCategorized

getJsonbDateFormatCategorized

getJsonbDateFormat

getJsonbNumberFormat

getJsonNumberFormatter

getConstructorNumberFormatter

getConstructorDateFormatter

getPropertyVisibilityStrategy

checkTransientIncompatible

collectInterfaces

introspectCustomization

getImplementationClass

collectAnnotations