<html> <head> <title>Interface XPersistObject</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XPersistObject-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">io</a> :: </p> </td> </tr> <tr> <td class="title">interface XPersistObject</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows to make UNO objects persistent </dd> <dd><p>Every UNO object, that wants to be serializable, should implement this interface. The object stores stores itself, when the write method is called. <p> The object needs to be created before it deserializes itself again (by using the read method). Therefor it must be createable by name via a factory, which is in general the global service manager. The create and read mechanism is implemented by the <a href="ObjectInputStream.html">ObjectInputStream</a>. <p>The serialization format (the series of strings, integers, objects) must be specified at the specification of the concrete service. <p>The interface does not support any special versioning mechanism. </dd> <dt><b>See also</b></dt> <dd><a href="XObjectOutputStream.html">XObjectOutputStream</a>, <a href="XObjectInputStream.html">XObjectInputStream</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getServiceName">getServiceName</a></td> <td class="imsum_right">gives the service name of the object </td> </tr> <tr> <td class="imsum_left"><a href="#write">write</a></td> <td class="imsum_right">writes all the persistent data of the object to the stream. </td> </tr> <tr> <td class="imsum_left"><a href="#read">read</a></td> <td class="imsum_right">reads all the persistent data of the object from the stream. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getServiceName" class="membertitle">getServiceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getServiceName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gives the service name of the object </dd> <dt><b>Returns</b></dt> <dd>the service name that specifies the behavior and the persistent data format of this implementation. <p>This name is used to create such an object by a factory during deserialization. </p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XServiceInfo.html">XServiceInfo</a>::<a href="../lang/XServiceInfo.html#getAvailableServiceNames">getAvailableServiceNames</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="write" class="membertitle">write</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>write</b>(</td> <td valign="top">[in] <a href="XObjectOutputStream.html">XObjectOutputStream</a></td> <td valign="bottom"> OutStream )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>writes all the persistent data of the object to the stream. </dd> <dd><p>The implementation must write the data in the order documented in the service specification. </dd> <dt><b>Parameter OutStream</b></dt> <dd>the stream, the data shall be written to. The stream supports simple types and other XPersistObject implementations. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="read" class="membertitle">read</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>read</b>(</td> <td valign="top">[in] <a href="XObjectInputStream.html">XObjectInputStream</a></td> <td valign="bottom"> InStream )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="IOException.html">IOException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>reads all the persistent data of the object from the stream. </dd> <dd><p>In case other XPersistObjects are read from the stream, the implementation uses a factory to create these objects (in general the global service manager). <p> The implementation must read the data in the order documented at the service specification. </dd> <dt><b>Parameter InStream</b></dt> <dd>the stream, the data shall be read from. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4031
