| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::CacheableFileName Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00466.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::CacheableFileName Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An immutable filename wrapper that can serve as a distributable key object for caching as well as being a string value. |
| <a href="a00466.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a00902.html">Apache::Geode::Client::ICacheableKey</a>, and Apache::Geode::Client::IDataSerializablePrimitive.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a7f316d2639f1514738ce226e81d5e8fa"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#a7f316d2639f1514738ce226e81d5e8fa">Equals</a> (<a class="el" href="a00902.html">ICacheableKey</a>^ other)</td></tr> |
| <tr class="memdesc:a7f316d2639f1514738ce226e81d5e8fa"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this key matches other object. <a href="#a7f316d2639f1514738ce226e81d5e8fa">More...</a><br /></td></tr> |
| <tr class="separator:a7f316d2639f1514738ce226e81d5e8fa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ca002c9adef8b324f60abb97b83b3b6"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#a7ca002c9adef8b324f60abb97b83b3b6">Equals</a> (Object^ obj) override</td></tr> |
| <tr class="memdesc:a7ca002c9adef8b324f60abb97b83b3b6"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this key matches other object. <a href="#a7ca002c9adef8b324f60abb97b83b3b6">More...</a><br /></td></tr> |
| <tr class="separator:a7ca002c9adef8b324f60abb97b83b3b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adccf5ff1b95bb25fb751f735d37a428c"><td class="memItemLeft" align="right" valign="top">virtual System::Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#adccf5ff1b95bb25fb751f735d37a428c">GetHashCode</a> () override</td></tr> |
| <tr class="memdesc:adccf5ff1b95bb25fb751f735d37a428c"><td class="mdescLeft"> </td><td class="mdescRight">Return the hashcode for this key. <a href="#adccf5ff1b95bb25fb751f735d37a428c">More...</a><br /></td></tr> |
| <tr class="separator:adccf5ff1b95bb25fb751f735d37a428c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70b00e8aa0f34bbbbfb07aabf3c4b67a"><td class="memItemLeft" align="right" valign="top">virtual String ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#a70b00e8aa0f34bbbbfb07aabf3c4b67a">ToString</a> () override</td></tr> |
| <tr class="memdesc:a70b00e8aa0f34bbbbfb07aabf3c4b67a"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of the object. <a href="#a70b00e8aa0f34bbbbfb07aabf3c4b67a">More...</a><br /></td></tr> |
| <tr class="separator:a70b00e8aa0f34bbbbfb07aabf3c4b67a"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:ae2b60453c131e79c24d416fc390bef76"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00466.html">CacheableFileName</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#ae2b60453c131e79c24d416fc390bef76">Create</a> (String^ value)</td></tr> |
| <tr class="memdesc:ae2b60453c131e79c24d416fc390bef76"><td class="mdescLeft"> </td><td class="mdescRight">Static function to create a new instance from the given string. <a href="#ae2b60453c131e79c24d416fc390bef76">More...</a><br /></td></tr> |
| <tr class="separator:ae2b60453c131e79c24d416fc390bef76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6318a8fc6d7efa67bd39d337447127e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00466.html">CacheableFileName</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#aa6318a8fc6d7efa67bd39d337447127e">Create</a> (array< Char >^ value)</td></tr> |
| <tr class="memdesc:aa6318a8fc6d7efa67bd39d337447127e"><td class="mdescLeft"> </td><td class="mdescRight">Static function to create a new instance from the given character array. <a href="#aa6318a8fc6d7efa67bd39d337447127e">More...</a><br /></td></tr> |
| <tr class="separator:aa6318a8fc6d7efa67bd39d337447127e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a1bd3c329eaed2d1325bbab0ee9447097"><td class="memItemLeft" align="right" valign="top">String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00466.html#a1bd3c329eaed2d1325bbab0ee9447097">Value</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1bd3c329eaed2d1325bbab0ee9447097"><td class="mdescLeft"> </td><td class="mdescRight">Gets the string value. <a href="#a1bd3c329eaed2d1325bbab0ee9447097">More...</a><br /></td></tr> |
| <tr class="separator:a1bd3c329eaed2d1325bbab0ee9447097"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An immutable filename wrapper that can serve as a distributable key object for caching as well as being a string value. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ae2b60453c131e79c24d416fc390bef76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae2b60453c131e79c24d416fc390bef76">◆ </a></span>Create() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00466.html">CacheableFileName</a> ^ Apache::Geode::Client::CacheableFileName::Create </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Static function to create a new instance from the given string. </p> |
| |
| </div> |
| </div> |
| <a id="aa6318a8fc6d7efa67bd39d337447127e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6318a8fc6d7efa67bd39d337447127e">◆ </a></span>Create() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00466.html">CacheableFileName</a> ^ Apache::Geode::Client::CacheableFileName::Create </td> |
| <td>(</td> |
| <td class="paramtype">array< Char >^ </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Static function to create a new instance from the given character array. </p> |
| |
| </div> |
| </div> |
| <a id="a7f316d2639f1514738ce226e81d5e8fa"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7f316d2639f1514738ce226e81d5e8fa">◆ </a></span>Equals() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Apache::Geode::Client::CacheableFileName::Equals </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00902.html">ICacheableKey</a>^ </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return true if this key matches other object. </p> |
| |
| <p>Implements <a class="el" href="a00902.html#abbc184ea4c9355db33f21213f978edf4">Apache::Geode::Client::ICacheableKey</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a7ca002c9adef8b324f60abb97b83b3b6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7ca002c9adef8b324f60abb97b83b3b6">◆ </a></span>Equals() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Apache::Geode::Client::CacheableFileName::Equals </td> |
| <td>(</td> |
| <td class="paramtype">Object^ </td> |
| <td class="paramname"><em>obj</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return true if this key matches other object. </p> |
| |
| </div> |
| </div> |
| <a id="adccf5ff1b95bb25fb751f735d37a428c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adccf5ff1b95bb25fb751f735d37a428c">◆ </a></span>GetHashCode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual System::Int32 Apache::Geode::Client::CacheableFileName::GetHashCode </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the hashcode for this key. </p> |
| |
| <p>Implements <a class="el" href="a00902.html#a541fd0835dd2941b0e84c9115cddaf5d">Apache::Geode::Client::ICacheableKey</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a70b00e8aa0f34bbbbfb07aabf3c4b67a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a70b00e8aa0f34bbbbfb07aabf3c4b67a">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual String ^ Apache::Geode::Client::CacheableFileName::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a string representation of the object. </p> |
| |
| <p>Implements <a class="el" href="a01022.html#a335290fd15fd41d39bc73a7ca10d19bd">Apache::Geode::Client::ISerializable</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a1bd3c329eaed2d1325bbab0ee9447097"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1bd3c329eaed2d1325bbab0ee9447097">◆ </a></span>Value</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::CacheableFileName::Value</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the string value. </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
