This document set describes the public APIs and SPIs offered by the Convertor module.
Contents
Overview
API overview
SPI overview
Additional documentation:
Change History
Architecture Summary
Credits:
The Convertor API was inspired by
core/settings module created by Jan Pokorsky and Jaroslav
Tulach. Credit must go to people from nbdev mailing list (especially to
Jesse Glick) for providing valuable feedback which was incorporated.
Overview
The convertor module allows to convert object to XML namespace aware
fragment and to convert this fragment back to instance of an
object.
The
module consists of SPI and API part. The SPI part defines convertor
interface to be implemented by clients and alternative for persistence
of object without the need to write your own convertor. The API part
has small set of
helper static methods operating on all available convertors which
clients can
use to convert XML fragments to objects and vice versa.
More concrete and detailed information including examples and list
of available convertors can be found at the following links:
- API overview - how to use convertors infrastructure and convert files
to objects and vice versa
- SPI overview - everything about writing convertors, list of existing
convertors, registration of convertors, etc.