JsonbTypeInfo

Skip navigation links

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element

```
@JsonbAnnotation
 @Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,TYPE})
public @interface JsonbTypeInfo
```
Configuration annotation of the type information handling.
This annotation is required on the most common parent of all classes when type information will be applied.
```
 // Example
  @JsonbTypeInfo(key = "@key")
 interface Animal {}

 class Dog implements Animal {}
 class Cat implements Animal {}
 
```
This annotation is tightly bound to JsonbSubtype. It is required to use JsonbSubtype annotations to specify all the possible classes and their aliases.

Field Summary

Fields
Modifier and Type Fields and Description

static java.lang.String DEFAULT_KEY_NAME
Default type information key name.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`java.lang.String`	`key` Key used for keeping the type information (alias).
`JsonbSubtype[]`	`value` Allowed aliases of the handled type.

- Field Detail
  - DEFAULT_KEY_NAME
```
public static final java.lang.String DEFAULT_KEY_NAME
```
    Default type information key name.
- Element Detail
  - key
```
public abstract java.lang.String key
```
    Key used for keeping the type information (alias). Default value is @type.
    
    Returns:
    
    key name
    
    Default:
    
    "@type"
- - value
```
public abstract JsonbSubtype[] value
```
    Allowed aliases of the handled type.
    
    Returns:
    
    list of allowed aliases
    
    Default:
    
    {}

Skip navigation links

All Classes

Summary:
Field |
Required |
Optional

Detail:
Field |
Element