<html> <head> <title>Interface XAtomServer</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="XAtomServer-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">util</a> :: </p> </td> </tr> <tr> <td class="title">interface XAtomServer</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>an interface to map between <i>string</i>s and <i>id</i>s </dd> <dd><p>a note on atoms:<br> Atoms are abbreviations for strings. When a string gets registered, it is assigned a numeric id so that said string can always be referred to by this id. This way strings have to be transported only once over remote connections. Valid ids are (in this implementation) non zero, signed 32 bit values. An atom of 0 means that the string in question is not registered</p> <p>Additionally there is the abstraction of atom class:<br> Atoms are grouped into classes, so that an id can be assigned to multiple strings, depending on the class context. The main advantage of this is that atoms in one class may be kept to small numbers, so that bandwidth can be reduced by sending the atoms only as 16 bit values. Note that it is up to the user in this case to handle overflows.</p> </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="#getClass">getClass</a></td> <td class="imsum_right">returns a whole atom class </td> </tr> <tr> <td class="imsum_left"><a href="#getClasses">getClasses</a></td> <td class="imsum_right">returns mutltiple atom classes </td> </tr> <tr> <td class="imsum_left"><a href="#getAtomDescriptions">getAtomDescriptions</a></td> <td class="imsum_right">returns the strings for an arbitrary amount of atoms of multiple classes </td> </tr> <tr> <td class="imsum_left"><a href="#getRecentAtoms">getRecentAtoms</a></td> <td class="imsum_right">returns the atoms that have been registered to a class after an already known atom </td> </tr> <tr> <td class="imsum_left"><a href="#getAtom">getAtom</a></td> <td class="imsum_right">registers or searches for a string </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="getClass" class="membertitle">getClass</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">sequence< <a href="AtomDescription.html">AtomDescription</a> ></td> </tr> <tr> <td valign="top"><b>getClass</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> atomClass );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a whole atom class </dd> <dt><b>Parameter atomClass</b></dt> <dd>which class to return </dd> <dt><b>Returns</b></dt> <dd>the descriptions for all atoms of class <code>atomClass</code> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getClasses" class="membertitle">getClasses</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">sequence< sequence< <a href="AtomDescription.html">AtomDescription</a> > ></td> </tr> <tr> <td valign="top"><b>getClasses</b>(</td> <td valign="top">[in] sequence< long ></td> <td valign="bottom"> atomClasses );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns mutltiple atom classes </dd> <dt><b>Parameter atomClasses</b></dt> <dd>which classes to return </dd> <dt><b>Returns</b></dt> <dd>the descriptions for all atoms of the requested classes </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAtomDescriptions" class="membertitle">getAtomDescriptions</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAtomDescriptions</b>(</td> <td valign="top">[in] sequence< <a href="AtomClassRequest.html">AtomClassRequest</a> ></td> <td valign="bottom"> atoms );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the strings for an arbitrary amount of atoms of multiple classes </dd> <dt><b>Parameter atoms</b></dt> <dd>describes which strings to return </dd> <dt><b>Returns</b></dt> <dd>the strings for the requested atoms </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRecentAtoms" class="membertitle">getRecentAtoms</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">sequence< <a href="AtomDescription.html">AtomDescription</a> ></td> </tr> <tr> <td valign="top"><b>getRecentAtoms</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> atomClass,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> atom );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the atoms that have been registered to a class after an already known atom </dd> <dd><p>Hint to implementor: using ascending atoms is the easiest way to decide, which atoms are recent.</p> </dd> <dt><b>Parameter atomClass</b></dt> <dd>the class in question </dd> <dt><b>Parameter atom</b></dt> <dd>the last known atom </dd> <dt><b>Returns</b></dt> <dd>all atom description that have been added to class <code>atomClass</code> after <code>atom</code> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAtom" class="membertitle">getAtom</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">long</td> </tr> <tr> <td valign="top"><b>getAtom</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> atomClass,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> description,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> create );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers or searches for a string </dd> <dt><b>Parameter atomClass</b></dt> <dd>the class of atoms in question </dd> <dt><b>Parameter description</b></dt> <dd>the string in question </dd> <dt><b>Parameter create</b></dt> <dd>if true a new atom will be created for an unknown string else the invalid atom (0) will be returned for an unknown string </dd> <dt><b>Returns</b></dt> <dd>the atom for the string <code>description</code> </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
>
7975
