← Back to branch summary

~akiban-technologies/akiban-persistit/trunk

« back to all changes in this revision

Viewing changes to doc/Serialization.rst

merge nwilliams: Minor formatting, wording, and link clean-ups for the final docs.

https://code.launchpad.net/~nwilliams/akiban-persistit/minor-doc-cleanup-for-oe/+merge/108224

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Serialization.rst
144
144
        ...
145
145
 
146
146
 
147
 
The ``com.persistit.serialOverride`` Configuration Property
 
147
The Serial Override Configuration Property
148
148
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
149
149
 
150
 
The ``serialOverride`` property specifies classes that are to be serialized by ``SerialValueCoder`` rather than ``DefaultValueCoder``. This property affects how Persistit assigns a value coder when none has previously been registered. It does not override or affect explicitly registered coders.
 
150
The ``com.persistit.serialOverride`` property specifies classes that are to be serialized by ``SerialValueCoder`` rather than ``DefaultValueCoder``. This property affects how Persistit assigns a value coder when none has previously been registered. It does not override or affect explicitly registered coders.
151
151
 
152
152
Names are separated by commas and may contain wild cards.
153
153
 
166
166
 
167
167
More precisely, ``serialOverride`` specifies a comma-delimited list of zero or more patterns, each of which is either a fully-qualified class name or pattern that has within it exactly one wild card. The wild card “\*” replaces any sequence of characters other than a period (“.”), while “\*\*” replaces any sequence of characters including periods.  For example::
168
168
 
169
 
  ``serialOverride=org.apache.**,com.mypkg.serialstuff.*,com.mypkg.MyClass``
 
169
  serialOverride=org.apache.**,com.mypkg.serialstuff.*,com.mypkg.MyClass
170
170
 
171
171
Like all configuration properties, you may specify this in the persistit.properties file or as a system property through a Java command-line argument in the form::
172
172
 
173
 
  ``-Dcom.persistit.serialOverride=...``
 
173
  -Dcom.persistit.serialOverride=...
174
174
 
175
175
Registering Objects in a Custom ``ValueCoder``
176
176
----------------------------------------------