Annotation Interface JsonAppend.Prop
- Enclosing class:
- JsonAppend
public static @interface JsonAppend.Prop
Definition of a single general virtual property.
-
Required Element Summary
Modifier and TypeRequired ElementDescriptionClass<? extends VirtualBeanPropertyWriter>
Actual implementation class (a subtype ofVirtualBeanPropertyWriter
) of the property to instantiate (using the no-argument default constructor). -
Optional Element Summary
Modifier and TypeOptional ElementDescriptionWhen to include value of the property.Name of the property to possibly use for serializing (although implementation may choose to not use this information).Optional namespace to use along withname()
; only relevant for data formats that use namespaces (like XML).boolean
Metadata about property, similar toJsonProperty.required()
.Class<?>
Nominal type of the property.
-
Element Details
-
value
Class<? extends VirtualBeanPropertyWriter> valueActual implementation class (a subtype ofVirtualBeanPropertyWriter
) of the property to instantiate (using the no-argument default constructor).
-
-
-
name
String nameName of the property to possibly use for serializing (although implementation may choose to not use this information).- Default:
- ""
-
namespace
String namespaceOptional namespace to use along withname()
; only relevant for data formats that use namespaces (like XML).- Default:
- ""
-
include
JsonInclude.Include includeWhen to include value of the property. Default value indicates that property should only be written if specified attribute has a non-null value. As with other properties, actual property implementation may or may not choose to use this inclusion information.- Default:
- NON_NULL
-
required
boolean requiredMetadata about property, similar toJsonProperty.required()
.- Default:
- false
-
type
Class<?> typeNominal type of the property. Passed as type information for related virtual objects, and may (or may not be) used by implementation for choosing serializer to use.- Default:
- java.lang.Object.class
-