Package de.xima.fc.annotations
Annotation Type EntityTransferDetails
-
@Retention(RUNTIME) @Target(TYPE) public @interface EntityTransferDetails
Annotation for customizing the serialization and deserialization process when exporting or importing an entity.- Since:
- 8.3.0
- Author:
- XIMA Media GmbH
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Class<? extends IEntityDeserializationExtension>
deserializationExtension
Can be used on any entity type.Class<? extends IEntityExportNameProvider>
exportNameProvider
Should only be used on entities of typeIFileEntity
.
-
-
-
Element Detail
-
deserializationExtension
Class<? extends IEntityDeserializationExtension> deserializationExtension
Can be used on any entity type. Allows customizing the deserialization process during entity import. Can be used e.g. to take into account deprecated fields.Must be set to a non-abstract class with a default constructor.
- Returns:
- The deserialization extension that should be used for the entity.
- Default:
- de.xima.fc.interfaces.extenstion.deserialization.IEntityDeserializationExtension.class
-
-
-
exportNameProvider
Class<? extends IEntityExportNameProvider> exportNameProvider
Should only be used on entities of typeIFileEntity
. The export ZIP archive will contain a file with the binary data of the file entity. This setting lets you customize the name that is used for the file in the ZIP archive. By default, the UUID is used if the entity implementsIUUIDEntity
, otherwise thefile name
.Must be set to a non-abstract class with a default constructor.
- Returns:
- The codec that is used to encode and decode the file name.
- Default:
- de.xima.fc.common.transfer.IEntityExportNameProvider.class
-
-