Google Git
Sign in
apache / geode-site / c1e1f5ba34f0a4e0af949688890f67e7e7b3f8f7 / . / releases / latest / dotnetdocs / a00522.html
blob: 8a363c12bb4f866ae4ffa48a547e70649f8a923f [file] [log] [blame]
<!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::CacheableString 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&amp;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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00522.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> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::CacheableString Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>An immutable string wrapper that can serve as a distributable key object for caching as well as being a string value.
<a href="a00522.html#details">More...</a></p>
<p>Inherits Apache::Geode::Client::IDataSerializablePrimitive, and <a class="el" href="a00498.html">Apache::Geode::Client::CacheableKey</a>.</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:a7886f653680ce94e73625dd57f87a982"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a7886f653680ce94e73625dd57f87a982">CacheableString</a> (String^ value)</td></tr>
<tr class="memdesc:a7886f653680ce94e73625dd57f87a982"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates a new instance copying from the given string. <a href="#a7886f653680ce94e73625dd57f87a982">More...</a><br /></td></tr>
<tr class="separator:a7886f653680ce94e73625dd57f87a982"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b24fb2bce107107793c229882fe120b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a1b24fb2bce107107793c229882fe120b">CacheableString</a> (array&lt; Char &gt;^ value)</td></tr>
<tr class="memdesc:a1b24fb2bce107107793c229882fe120b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates a new instance copying from the given character array. <a href="#a1b24fb2bce107107793c229882fe120b">More...</a><br /></td></tr>
<tr class="separator:a1b24fb2bce107107793c229882fe120b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a2460e9d4406ee59ce66c69e7fd1b58"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a8a2460e9d4406ee59ce66c69e7fd1b58">Equals</a> (<a class="el" href="a00902.html">Apache::Geode::Client::ICacheableKey</a>^ other) override</td></tr>
<tr class="memdesc:a8a2460e9d4406ee59ce66c69e7fd1b58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this key matches other object. <a href="#a8a2460e9d4406ee59ce66c69e7fd1b58">More...</a><br /></td></tr>
<tr class="separator:a8a2460e9d4406ee59ce66c69e7fd1b58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50042e482b211d560d6ea8f09ed4d466"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a50042e482b211d560d6ea8f09ed4d466">Equals</a> (Object^ obj) override</td></tr>
<tr class="memdesc:a50042e482b211d560d6ea8f09ed4d466"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this key matches other object. <a href="#a50042e482b211d560d6ea8f09ed4d466">More...</a><br /></td></tr>
<tr class="separator:a50042e482b211d560d6ea8f09ed4d466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77581c5e5934134d743f4c09bcc20264"><td class="memItemLeft" align="right" valign="top">virtual System::Int32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a77581c5e5934134d743f4c09bcc20264">GetHashCode</a> () override</td></tr>
<tr class="memdesc:a77581c5e5934134d743f4c09bcc20264"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the hashcode for this key. <a href="#a77581c5e5934134d743f4c09bcc20264">More...</a><br /></td></tr>
<tr class="separator:a77581c5e5934134d743f4c09bcc20264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bbf6e7b40afcdb5f34d7c26fb14b5ca"><td class="memItemLeft" align="right" valign="top">virtual String ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a5bbf6e7b40afcdb5f34d7c26fb14b5ca">ToString</a> () override</td></tr>
<tr class="memdesc:a5bbf6e7b40afcdb5f34d7c26fb14b5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the object. <a href="#a5bbf6e7b40afcdb5f34d7c26fb14b5ca">More...</a><br /></td></tr>
<tr class="separator:a5bbf6e7b40afcdb5f34d7c26fb14b5ca"><td class="memSeparator" colspan="2">&#160;</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:ab1a4dcbf1d02f6734b0c1636b0c8da16"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00522.html">CacheableString</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#ab1a4dcbf1d02f6734b0c1636b0c8da16">Create</a> (String^ value)</td></tr>
<tr class="memdesc:ab1a4dcbf1d02f6734b0c1636b0c8da16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to create a new instance copying from the given string. <a href="#ab1a4dcbf1d02f6734b0c1636b0c8da16">More...</a><br /></td></tr>
<tr class="separator:ab1a4dcbf1d02f6734b0c1636b0c8da16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83b39e524f9209cd13eabdf622954f56"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00522.html">CacheableString</a> ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a83b39e524f9209cd13eabdf622954f56">Create</a> (array&lt; Char &gt;^ value)</td></tr>
<tr class="memdesc:a83b39e524f9209cd13eabdf622954f56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to create a new instance copying from the given character array. <a href="#a83b39e524f9209cd13eabdf622954f56">More...</a><br /></td></tr>
<tr class="separator:a83b39e524f9209cd13eabdf622954f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e28a866226c76e2a83265c6dc2de6b2"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a7e28a866226c76e2a83265c6dc2de6b2">IsNullOrEmpty</a> (<a class="el" href="a00522.html">CacheableString</a>^ value)</td></tr>
<tr class="memdesc:a7e28a866226c76e2a83265c6dc2de6b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static function to check whether IsNullOrEmpty. <a href="#a7e28a866226c76e2a83265c6dc2de6b2">More...</a><br /></td></tr>
<tr class="separator:a7e28a866226c76e2a83265c6dc2de6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35d8b124f0c74119bc2b562eb6a1db01"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#a35d8b124f0c74119bc2b562eb6a1db01">operator CacheableKey^</a> (bool value)</td></tr>
<tr class="memdesc:a35d8b124f0c74119bc2b562eb6a1db01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a boolean to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#a35d8b124f0c74119bc2b562eb6a1db01">More...</a><br /></td></tr>
<tr class="separator:a35d8b124f0c74119bc2b562eb6a1db01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb03559f0e734c75992ee5a949d88a4f"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#adb03559f0e734c75992ee5a949d88a4f">operator CacheableKey^</a> (Byte value)</td></tr>
<tr class="memdesc:adb03559f0e734c75992ee5a949d88a4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a byte to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#adb03559f0e734c75992ee5a949d88a4f">More...</a><br /></td></tr>
<tr class="separator:adb03559f0e734c75992ee5a949d88a4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeda53e97287406532f3dde523a5c6674"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#aeda53e97287406532f3dde523a5c6674">operator CacheableKey^</a> (Double value)</td></tr>
<tr class="memdesc:aeda53e97287406532f3dde523a5c6674"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a double to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#aeda53e97287406532f3dde523a5c6674">More...</a><br /></td></tr>
<tr class="separator:aeda53e97287406532f3dde523a5c6674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefc98e13c9435b6a17ca21ae9e58f45c"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#aefc98e13c9435b6a17ca21ae9e58f45c">operator CacheableKey^</a> (Single value)</td></tr>
<tr class="memdesc:aefc98e13c9435b6a17ca21ae9e58f45c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a float to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#aefc98e13c9435b6a17ca21ae9e58f45c">More...</a><br /></td></tr>
<tr class="separator:aefc98e13c9435b6a17ca21ae9e58f45c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1d43d99eb1699ff51cd109721a55d0b"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#ac1d43d99eb1699ff51cd109721a55d0b">operator CacheableKey^</a> (System::Int16 value)</td></tr>
<tr class="memdesc:ac1d43d99eb1699ff51cd109721a55d0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a 16-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#ac1d43d99eb1699ff51cd109721a55d0b">More...</a><br /></td></tr>
<tr class="separator:ac1d43d99eb1699ff51cd109721a55d0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7097ceae6f88dc136233b150da8859c4"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#a7097ceae6f88dc136233b150da8859c4">operator CacheableKey^</a> (Char value)</td></tr>
<tr class="memdesc:a7097ceae6f88dc136233b150da8859c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a character to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#a7097ceae6f88dc136233b150da8859c4">More...</a><br /></td></tr>
<tr class="separator:a7097ceae6f88dc136233b150da8859c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46ac082503f3cfb7b38ff0eb33489be8"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#a46ac082503f3cfb7b38ff0eb33489be8">operator CacheableKey^</a> (System::Int32 value)</td></tr>
<tr class="memdesc:a46ac082503f3cfb7b38ff0eb33489be8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a 32-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#a46ac082503f3cfb7b38ff0eb33489be8">More...</a><br /></td></tr>
<tr class="separator:a46ac082503f3cfb7b38ff0eb33489be8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a70369be59b5a8541c506910b6e5e71"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#a1a70369be59b5a8541c506910b6e5e71">operator CacheableKey^</a> (System::Int64 value)</td></tr>
<tr class="memdesc:a1a70369be59b5a8541c506910b6e5e71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a 64-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#a1a70369be59b5a8541c506910b6e5e71">More...</a><br /></td></tr>
<tr class="separator:a1a70369be59b5a8541c506910b6e5e71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcc218644681073a3a9d151aea9c7f80"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00498.html#adcc218644681073a3a9d151aea9c7f80">operator CacheableKey^</a> (String^ value)</td></tr>
<tr class="memdesc:adcc218644681073a3a9d151aea9c7f80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator from a string to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. <a href="#adcc218644681073a3a9d151aea9c7f80">More...</a><br /></td></tr>
<tr class="separator:adcc218644681073a3a9d151aea9c7f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af788f48e6c0308df9332af483ede3f15"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#af788f48e6c0308df9332af483ede3f15">operator String ^</a> (<a class="el" href="a00522.html">CacheableString</a>^ str)</td></tr>
<tr class="memdesc:af788f48e6c0308df9332af483ede3f15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implicit conversion operator to underlying <code>System.String</code>. <a href="#af788f48e6c0308df9332af483ede3f15">More...</a><br /></td></tr>
<tr class="separator:af788f48e6c0308df9332af483ede3f15"><td class="memSeparator" colspan="2">&#160;</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:ae10477befd426855e492b36ac85ade13"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#ae10477befd426855e492b36ac85ade13">IsWideString</a><code> [get]</code></td></tr>
<tr class="memdesc:ae10477befd426855e492b36ac85ade13"><td class="mdescLeft">&#160;</td><td class="mdescRight">True when the underlying C string is a wide-character string. <a href="#ae10477befd426855e492b36ac85ade13">More...</a><br /></td></tr>
<tr class="separator:ae10477befd426855e492b36ac85ade13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d8117316254b20c78e05ad82cf40423"><td class="memItemLeft" align="right" valign="top">System::UInt32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a4d8117316254b20c78e05ad82cf40423">Length</a><code> [get]</code></td></tr>
<tr class="memdesc:a4d8117316254b20c78e05ad82cf40423"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the length of the underlying C string. <a href="#a4d8117316254b20c78e05ad82cf40423">More...</a><br /></td></tr>
<tr class="separator:a4d8117316254b20c78e05ad82cf40423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0181ca94f481782c335004a15595d7f8"><td class="memItemLeft" align="right" valign="top">String^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00522.html#a0181ca94f481782c335004a15595d7f8">Value</a><code> [get]</code></td></tr>
<tr class="memdesc:a0181ca94f481782c335004a15595d7f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the string value. <a href="#a0181ca94f481782c335004a15595d7f8">More...</a><br /></td></tr>
<tr class="separator:a0181ca94f481782c335004a15595d7f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An immutable string wrapper that can serve as a distributable key object for caching as well as being a string value. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7886f653680ce94e73625dd57f87a982"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7886f653680ce94e73625dd57f87a982">&#9670;&nbsp;</a></span>CacheableString() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache::Geode::Client::CacheableString::CacheableString </td>
<td>(</td>
<td class="paramtype">String^&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a new instance copying from the given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the string value of the new instance</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if the provided string is null or has zero length </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1b24fb2bce107107793c229882fe120b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b24fb2bce107107793c229882fe120b">&#9670;&nbsp;</a></span>CacheableString() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache::Geode::Client::CacheableString::CacheableString </td>
<td>(</td>
<td class="paramtype">array&lt; Char &gt;^&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocates a new instance copying from the given character array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the character array value of the new instance </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if the provided array is null or has zero length </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab1a4dcbf1d02f6734b0c1636b0c8da16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1a4dcbf1d02f6734b0c1636b0c8da16">&#9670;&nbsp;</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="a00522.html">CacheableString</a> ^ Apache::Geode::Client::CacheableString::Create </td>
<td>(</td>
<td class="paramtype">String^&#160;</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 copying from the given string. </p>
<p>Providing a null or zero size string will return a null <code><a class="el" href="a00522.html" title="An immutable string wrapper that can serve as a distributable key object for caching as well as being...">CacheableString</a></code> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the string value of the new instance</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a83b39e524f9209cd13eabdf622954f56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b39e524f9209cd13eabdf622954f56">&#9670;&nbsp;</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="a00522.html">CacheableString</a> ^ Apache::Geode::Client::CacheableString::Create </td>
<td>(</td>
<td class="paramtype">array&lt; Char &gt;^&#160;</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 copying from the given character array. </p>
<p>Providing a null or zero size character array will return a null <code><a class="el" href="a00522.html" title="An immutable string wrapper that can serve as a distributable key object for caching as well as being...">CacheableString</a></code> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the character array value of the new instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8a2460e9d4406ee59ce66c69e7fd1b58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a2460e9d4406ee59ce66c69e7fd1b58">&#9670;&nbsp;</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::CacheableString::Equals </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00902.html">Apache::Geode::Client::ICacheableKey</a>^&#160;</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">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>
<p>It invokes the '==' operator of the underlying <code>apache::geode::client::CacheableString</code> object. </p>
<p>Reimplemented from <a class="el" href="a00498.html#a5431c8fb0bc4b2fed7e18efdb994e57d">Apache::Geode::Client::CacheableKey</a>.</p>
</div>
</div>
<a id="a50042e482b211d560d6ea8f09ed4d466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50042e482b211d560d6ea8f09ed4d466">&#9670;&nbsp;</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::CacheableString::Equals </td>
<td>(</td>
<td class="paramtype">Object^&#160;</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>
<p>It invokes the '==' operator of the underlying <code>apache::geode::client::CacheableString</code> object. </p>
<p>Reimplemented from <a class="el" href="a00498.html#a7d9ba3bd7851aa680dc56654eb44c00d">Apache::Geode::Client::CacheableKey</a>.</p>
</div>
</div>
<a id="a77581c5e5934134d743f4c09bcc20264"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77581c5e5934134d743f4c09bcc20264">&#9670;&nbsp;</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::CacheableString::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>Reimplemented from <a class="el" href="a00498.html#a9a88344340ac7b9d298672439f264997">Apache::Geode::Client::CacheableKey</a>.</p>
</div>
</div>
<a id="a7e28a866226c76e2a83265c6dc2de6b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e28a866226c76e2a83265c6dc2de6b2">&#9670;&nbsp;</a></span>IsNullOrEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool Apache::Geode::Client::CacheableString::IsNullOrEmpty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00522.html">CacheableString</a>^&#160;</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 check whether IsNullOrEmpty. </p>
<p>This is similar to the C# string.IsNullOrEmpty method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>the <a class="el" href="a00522.html" title="An immutable string wrapper that can serve as a distributable key object for caching as well as being...">CacheableString</a> value to check</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a35d8b124f0c74119bc2b562eb6a1db01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35d8b124f0c74119bc2b562eb6a1db01">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[1/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">bool&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a boolean to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="adb03559f0e734c75992ee5a949d88a4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb03559f0e734c75992ee5a949d88a4f">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[2/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">Byte&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a byte to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="aeda53e97287406532f3dde523a5c6674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeda53e97287406532f3dde523a5c6674">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[3/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">Double&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a double to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="aefc98e13c9435b6a17ca21ae9e58f45c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefc98e13c9435b6a17ca21ae9e58f45c">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[4/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">Single&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a float to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="ac1d43d99eb1699ff51cd109721a55d0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1d43d99eb1699ff51cd109721a55d0b">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[5/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">System::Int16&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a 16-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="a7097ceae6f88dc136233b150da8859c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7097ceae6f88dc136233b150da8859c4">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[6/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">Char&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a character to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="a46ac082503f3cfb7b38ff0eb33489be8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46ac082503f3cfb7b38ff0eb33489be8">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[7/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">System::Int32&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a 32-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="a1a70369be59b5a8541c506910b6e5e71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a70369be59b5a8541c506910b6e5e71">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[8/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">System::Int64&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a 64-bit integer to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="adcc218644681073a3a9d151aea9c7f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcc218644681073a3a9d151aea9c7f80">&#9670;&nbsp;</a></span>operator CacheableKey^() <span class="overload">[9/9]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableKey::operator <a class="el" href="a00498.html">CacheableKey</a>^ </td>
<td>(</td>
<td class="paramtype">String^&#160;</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">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicit conversion operator from a string to a <code><a class="el" href="a00498.html" title="This class wraps the native C++ apache::geode::client::Serializable objects as managed ....">CacheableKey</a></code>. </p>
</div>
</div>
<a id="af788f48e6c0308df9332af483ede3f15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af788f48e6c0308df9332af483ede3f15">&#9670;&nbsp;</a></span>operator String ^()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Apache::Geode::Client::CacheableString::operator String ^ </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00522.html">CacheableString</a>^&#160;</td>
<td class="paramname"><em>str</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>Implicit conversion operator to underlying <code>System.String</code>. </p>
</div>
</div>
<a id="a5bbf6e7b40afcdb5f34d7c26fb14b5ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bbf6e7b40afcdb5f34d7c26fb14b5ca">&#9670;&nbsp;</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::CacheableString::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>This returns the same string as <code>Value</code> property. </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="ae10477befd426855e492b36ac85ade13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae10477befd426855e492b36ac85ade13">&#9670;&nbsp;</a></span>IsWideString</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache::Geode::Client::CacheableString::IsWideString</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>True when the underlying C string is a wide-character string. </p>
</div>
</div>
<a id="a4d8117316254b20c78e05ad82cf40423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d8117316254b20c78e05ad82cf40423">&#9670;&nbsp;</a></span>Length</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">System:: UInt32 Apache::Geode::Client::CacheableString::Length</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 length of the underlying C string. </p>
</div>
</div>
<a id="a0181ca94f481782c335004a15595d7f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0181ca94f481782c335004a15595d7f8">&#9670;&nbsp;</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::CacheableString::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>