<html> <head> <title>Interface XURLTransformer</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="XURLTransformer-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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 XURLTransformer</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>supports parsing and assembling of URLs </dd> <dt><b>See also</b></dt> <dd><a href="URL.html">URL</a>, <a href="URLTransformer.html">URLTransformer</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="#parseStrict">parseStrict</a></td> <td class="imsum_right">parses the string in <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> which should contain a syntactically complete URL. </td> </tr> <tr> <td class="imsum_left"><a href="#parseSmart">parseSmart</a></td> <td class="imsum_right">parses the string in <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a>, which may contain a syntactically complete URL or is specified by the provided protocol </td> </tr> <tr> <td class="imsum_left"><a href="#assemble">assemble</a></td> <td class="imsum_right">assembles the parts of the URL specified by <var>aURL</var> and stores it into <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> </td> </tr> <tr> <td class="imsum_left"><a href="#getPresentation">getPresentation</a></td> <td class="imsum_right">returns a representation of the URL for UI purposes only </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="parseStrict" class="membertitle">parseStrict</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">boolean</td> </tr> <tr> <td valign="top"><b>parseStrict</b>(</td> <td valign="top">[inout] <a href="URL.html">URL</a></td> <td valign="bottom"> aURL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>parses the string in <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> which should contain a syntactically complete URL. </dd> <dd><p> The implementation is allowed to correct minor failures in <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> if the meaning of the URL remain unchanged. Parts of the URL are stored in the other fields of <var>aURL</var>. </p> </dd> <dt><b>Parameter aURL</b></dt> <dd>the URL which include the complete string notation and will contain all parsed parts of it after finishing this call. <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> can be overwritten if the implementation corrected minor failures. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if parsing was successfully (means if given URL was syntactically correct) or <b>false</b> otherwhise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="parseSmart" class="membertitle">parseSmart</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">boolean</td> </tr> <tr> <td valign="top"><b>parseSmart</b>(</td> <td valign="top">[inout] <a href="URL.html">URL</a></td> <td valign="bottom"> aURL,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sSmartProtocol );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>parses the string in <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a>, which may contain a syntactically complete URL or is specified by the provided protocol </dd> <dd><p> The implementation can use smart functions to correct or interpret <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> if it is not a syntactically complete URL. The parts of the URL are stored in the other fields of <var>aURL</var>. </p> </dd> <dt><b>Parameter aURL</b></dt> <dd>the URL which include the string notation and will contain all parsed parts of it after finishing this call. This includes <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a>. </dd> <dt><b>Parameter sSmartProtocol</b></dt> <dd>optional information which protocol specification should be used to parse member<a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a>. If empty the implementation can use a protocol which fit best. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if parsing was successful (means if <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> could be syntactically correct) or <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="assemble" class="membertitle">assemble</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">boolean</td> </tr> <tr> <td valign="top"><b>assemble</b>(</td> <td valign="top">[inout] <a href="URL.html">URL</a></td> <td valign="bottom"> aURL );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>assembles the parts of the URL specified by <var>aURL</var> and stores it into <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> </dd> <dt><b>Parameter aURL</b></dt> <dd>the URL which contains alls neccessary information in a structured form. The member <a href="URL.html">URL</a>::<a href="URL.html#Complete">Complete</a> contains the URL in string notation after the operation finished successfully. Otherwise the content of <a href="URL.html">URL</a>::<a href="URL.html#complete">complete</a> is not defined. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if assembling was successfully or <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPresentation" class="membertitle">getPresentation</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>getPresentation</b>(</td> <td valign="top">[in] <a href="URL.html">URL</a></td> <td valign="bottom"> aURL,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bWithPassword );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a representation of the URL for UI purposes only </dd> <dd><p> Sometimes it can be usefull to show an URL on an user interface in a more "human readable" form. Such URL can't be used on any API call, but make it easier for the user to understand it. </p> </dd> <dt><b>Parameter aURL</b></dt> <dd>URL in structured form which should be shown at the UI </dd> <dt><b>Parameter bWithPassword</b></dt> <dd>specifies whether the password will be included in the encoding or not. Usually passwords should never be shown at the user interface. </dd> <dt><b>Returns</b></dt> <dd>a string representing the <var>aURL</var> if it is syntactically correct. A empty string if <var>aURL</var> is not syntactically correct. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
7737
