Label Capture Deserializer

Defined in package com.scandit.datacapture.label.capture.serialization

Warning

The deserialization API is not yet stable and will still change over the coming releases.

Note

This deserializer is not thread-safe, subsequent calls for the same settings, mode or overlay have to be called on the same thread.

LabelCaptureDeserializer

class LabelCaptureDeserializer : DataCaptureModeDeserializer

Added in version 6.4.0

A deserializer to construct label capture from JSON. For most use cases it is enough to use LabelCapture.fromJson() which internally uses this deserializer. Using the deserializer gives the advantage of being able to listen to the deserialization events as they happen and potentially influence them. Additionally warnings can be read from the deserializer that would otherwise not be available.

Related topics: Serialization.

LabelCaptureDeserializer()

LabelCaptureDeserializer()

Added in version 6.4.0

Creates a new deserializer object.

listener

@NonNull LabelCaptureDeserializerListener getListener()
void setListener(@NonNull LabelCaptureDeserializerListener value)

Added in version 6.4.0

The object informed about deserialization events.

warnings

@NonNull List<@NonNull String> getWarnings()

Added in version 6.4.0

The warnings produced during deserialization, for example which properties were not used during deserialization.

modeFromJson(dataCaptureContext, jsonData)

LabelCapture modeFromJson(DataCaptureContext dataCaptureContext,
        @NonNull String jsonData)

Added in version 6.4.0

Deserializes label capture from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateModeFromJson(mode, jsonData)

@NonNull LabelCapture updateModeFromJson(@NonNull LabelCapture mode,
        @NonNull String jsonData)

Added in version 6.4.0

Takes an existing label capture and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

settingsFromJson(jsonData)

@NonNull LabelCaptureSettings settingsFromJson(@NonNull String jsonData)

Added in version 6.4.0

Deserializes label capture settings from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateSettingsFromJson(settings, jsonData)

@NonNull LabelCaptureSettings updateSettingsFromJson(
        @NonNull LabelCaptureSettings settings,
        @NonNull String jsonData)

Added in version 6.4.0

Takes existing label capture settings and updates them by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

basicOverlayFromJson(mode, jsonData)

@NonNull LabelCaptureBasicOverlay basicOverlayFromJson(
        @NonNull LabelCapture mode,
        @NonNull String jsonData)

Added in version 6.4.0

Deserializes a label capture overlay from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateBasicOverlayFromJson(overlay, jsonData)

@NonNull LabelCaptureBasicOverlay updateBasicOverlayFromJson(
        @NonNull LabelCaptureBasicOverlay overlay,
        @NonNull String jsonData)

Added in version 6.4.0

Takes an existing label capture overlay and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

advancedOverlayFromJson(mode, jsonData)

@NonNull LabelCaptureAdvancedOverlay advancedOverlayFromJson(
        @NonNull LabelCapture mode,
        @NonNull String jsonData)

Added in version 6.16.0

Deserializes a label capture advanced overlay from JSON.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.

updateAdvancedOverlayFromJson(overlay, jsonData)

@NonNull LabelCaptureAdvancedOverlay updateAdvancedOverlayFromJson(
        @NonNull LabelCaptureAdvancedOverlay overlay,
        @NonNull String jsonData)

Added in version 6.16.0

Takes an existing label capture advanced overlay and updates it by deserializing new or changed properties from JSON. See Updating from JSON for details of how updates are being done.

An exception is thrown if the provided JSON does not contain required properties or contains properties of the wrong type.