Version 1 of the interface that supports serializing by the client supplied serializer of the XMP Data Model.
More...
#include <IClientDOMSerializer.h>
Version 1 of the interface that supports serializing by the client supplied serializer of the XMP Data Model.
Provides functions to serialize the XMP Data Model. Thread safety is controllable by the client.
Definition at line 27 of file IClientDOMSerializer.h.
◆ ~IClientDOMSerializer_v1()
virtual AdobeXMPCore::IClientDOMSerializer_v1::~IClientDOMSerializer_v1 |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ AreKeysCaseSensitive()
virtual bool APICALL AdobeXMPCore::IClientDOMSerializer_v1::AreKeysCaseSensitive |
( |
| ) |
const |
|
inlinevirtual |
Indicates whether object supports case sensitive keys or not.
- Returns
- True in case object supports case sensitive keys, false otherwise.
- Note
- Default implementation makes keys case insensitive.
Definition at line 48 of file IClientDOMSerializer.h.
◆ Initialize()
virtual void APICALL AdobeXMPCore::IClientDOMSerializer_v1::Initialize |
( |
pIConfigurable |
configurationParameters | ) |
|
|
inlinevirtual |
Initializes the default configuration parameters. The object needs to fill the default configuration parameters supported by it.
- Parameters
-
- Note
- Default implementation does not fill anything in the configuration parameters.
Definition at line 56 of file IClientDOMSerializer.h.
◆ Release()
virtual void APICALL AdobeXMPCore::IClientDOMSerializer_v1::Release |
( |
| ) |
const |
|
pure virtual |
Called by the library when the object is no longer required by it and client can free up the resources or memory associated with the object.
◆ Serialize()
Serialize the XMP Data Model taking into account the configuration parameters.
- Parameters
-
[in] | node | The node to be serialized. |
[in] | nameSpacePrefixMap | An object of type #INameSpacePrefixMap which contains preferred prefixes for namespaces. |
[in] | configurationParameters | An object of type AdobeXMPCommon::IConfigurable containing all the configuration parameters requested by client to be taken care of while serializing. |
[in] | functor | A function object to be used by the serializing operation to report back any encountered errors/warnings. |
[out] | string | A shared pointer to an IUTF8String object which should be filled with the serialized form of XMP Data Model. |
◆ Validate()
Validate the data type and value for a parameter.
- Parameters
-
- Returns
- An error code in case there is something wrong with the combination, otherwise returns #AdobeXMPCommon::eCECNone.
- Note
- Default implementation validates all the keys + dataTypes + dataValue combinations.
Definition at line 66 of file IClientDOMSerializer.h.
References AdobeXMPCommon::kCECNone.
The documentation for this class was generated from the following file: