<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09-icedtea) on Sat Mar 02 06:46:26 UTC 2013 -->
<title>OtpErlangString (Java-Erlang Interface Library)</title>
<meta name="date" content="2013-03-02">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="OtpErlangString (Java-Erlang Interface Library)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/ericsson/otp/erlang/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangShort.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangTuple.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpErlangString.html" target="_top">Frames</a></li>
<li><a href="OtpErlangString.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Nested</a> | </li>
<li><a href="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ericsson.otp.erlang</div>
<h2 title="Class OtpErlangString" class="title">Class OtpErlangString</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">com.ericsson.otp.erlang.OtpErlangObject</a></li>
<li>
<ul class="inheritance">
<li>com.ericsson.otp.erlang.OtpErlangString</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">OtpErlangString</span>
extends <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a>
implements java.io.Serializable, java.lang.Cloneable</pre>
<div class="block">Provides a Java representation of Erlang strings.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.ericsson.otp.erlang.OtpErlangString">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.Hash.html" title="class in com.ericsson.otp.erlang">OtpErlangObject.Hash</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!-- -->
</a>
<h3>Fields inherited from class com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#hashCodeValue">hashCodeValue</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#OtpErlangString(com.ericsson.otp.erlang.OtpErlangList)">OtpErlangString</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpErlangList.html" title="class in com.ericsson.otp.erlang">OtpErlangList</a> list)</code>
<div class="block">Create an Erlang string from a list of integers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#OtpErlangString(com.ericsson.otp.erlang.OtpInputStream)">OtpErlangString</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</a> buf)</code>
<div class="block">Create an Erlang string from a stream containing a string encoded in
Erlang external format.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#OtpErlangString(java.lang.String)">OtpErlangString</a></strong>(java.lang.String str)</code>
<div class="block">Create an Erlang string from the given string.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#doHashCode()">doHashCode</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#encode(com.ericsson.otp.erlang.OtpOutputStream)">encode</a></strong>(<a href="../../../../com/ericsson/otp/erlang/OtpOutputStream.html" title="class in com.ericsson.otp.erlang">OtpOutputStream</a> buf)</code>
<div class="block">Convert this string to the equivalent Erlang external representation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code>
<div class="block">Determine if two strings are equal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#isValidCodePoint(int)">isValidCodePoint</a></strong>(int cp)</code>
<div class="block">Validate a code point according to Erlang definition; Unicode 3.0.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#newString(byte[])">newString</a></strong>(byte[] bytes)</code>
<div class="block">Construct a String from a Latin-1 (ISO-8859-1) encoded byte array,
if Latin-1 is available, otherwise use the default encoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#stringToCodePoints(java.lang.String)">stringToCodePoints</a></strong>(java.lang.String s)</code>
<div class="block">Create Unicode code points from a String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#stringValue()">stringValue</a></strong>()</code>
<div class="block">Get the actual string contained in this object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#toString()">toString</a></strong>()</code>
<div class="block">Get the printable version of the string contained in this object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">
<!-- -->
</a>
<h3>Methods inherited from class com.ericsson.otp.erlang.<a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></h3>
<code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#clone()">clone</a>, <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#decode(com.ericsson.otp.erlang.OtpInputStream)">decode</a>, <a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#hashCode()">hashCode</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="OtpErlangString(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OtpErlangString</h4>
<pre>public OtpErlangString(java.lang.String str)</pre>
<div class="block">Create an Erlang string from the given string.</div>
</li>
</ul>
<a name="OtpErlangString(com.ericsson.otp.erlang.OtpErlangList)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OtpErlangString</h4>
<pre>public OtpErlangString(<a href="../../../../com/ericsson/otp/erlang/OtpErlangList.html" title="class in com.ericsson.otp.erlang">OtpErlangList</a> list)
throws <a href="../../../../com/ericsson/otp/erlang/OtpErlangException.html" title="class in com.ericsson.otp.erlang">OtpErlangException</a></pre>
<div class="block">Create an Erlang string from a list of integers.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangException.html" title="class in com.ericsson.otp.erlang">OtpErlangException</a></code> - for non-proper and non-integer lists.</dd>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangRangeException.html" title="class in com.ericsson.otp.erlang">OtpErlangRangeException</a></code> - if an integer in the list is not
a valid Unicode code point according to Erlang.</dd></dl>
</li>
</ul>
<a name="OtpErlangString(com.ericsson.otp.erlang.OtpInputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OtpErlangString</h4>
<pre>public OtpErlangString(<a href="../../../../com/ericsson/otp/erlang/OtpInputStream.html" title="class in com.ericsson.otp.erlang">OtpInputStream</a> buf)
throws <a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</a></pre>
<div class="block">Create an Erlang string from a stream containing a string encoded in
Erlang external format.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - the stream containing the encoded string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangDecodeException.html" title="class in com.ericsson.otp.erlang">OtpErlangDecodeException</a></code> - if the buffer does not contain a valid external
representation of an Erlang string.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="stringValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringValue</h4>
<pre>public java.lang.String stringValue()</pre>
<div class="block">Get the actual string contained in this object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the raw string contained in this object, without regard to Erlang
quoting rules.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#toString()"><code>toString()</code></a></dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Get the printable version of the string contained in this object.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#toString()">toString</a></code> in class <code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string contained in this object, quoted.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/ericsson/otp/erlang/OtpErlangString.html#stringValue()"><code>stringValue()</code></a></dd></dl>
</li>
</ul>
<a name="encode(com.ericsson.otp.erlang.OtpOutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public void encode(<a href="../../../../com/ericsson/otp/erlang/OtpOutputStream.html" title="class in com.ericsson.otp.erlang">OtpOutputStream</a> buf)</pre>
<div class="block">Convert this string to the equivalent Erlang external representation.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#encode(com.ericsson.otp.erlang.OtpOutputStream)">encode</a></code> in class <code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - an output stream to which the encoded string should be
written.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<div class="block">Determine if two strings are equal. They are equal if they represent the
same sequence of characters. This method can be used to compare
OtpErlangStrings with each other and with Strings.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o</code> - the OtpErlangString or String to compare to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the strings consist of the same sequence of characters,
false otherwise.</dd></dl>
</li>
</ul>
<a name="doHashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doHashCode</h4>
<pre>protected int doHashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html#doHashCode()">doHashCode</a></code> in class <code><a href="../../../../com/ericsson/otp/erlang/OtpErlangObject.html" title="class in com.ericsson.otp.erlang">OtpErlangObject</a></code></dd>
</dl>
</li>
</ul>
<a name="stringToCodePoints(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringToCodePoints</h4>
<pre>public static int[] stringToCodePoints(java.lang.String s)</pre>
<div class="block">Create Unicode code points from a String.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - a String to convert to an Unicode code point array</dd>
<dt><span class="strong">Returns:</span></dt><dd>the corresponding array of integers representing
Unicode code points</dd></dl>
</li>
</ul>
<a name="isValidCodePoint(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidCodePoint</h4>
<pre>public static boolean isValidCodePoint(int cp)</pre>
<div class="block">Validate a code point according to Erlang definition; Unicode 3.0.
That is; valid in the range U+0..U+10FFFF, but not in the range
U+D800..U+DFFF (surrogat pairs).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cp</code> - the code point value to validate</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the code point is valid,
false otherwise.</dd></dl>
</li>
</ul>
<a name="newString(byte[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newString</h4>
<pre>public static java.lang.String newString(byte[] bytes)</pre>
<div class="block">Construct a String from a Latin-1 (ISO-8859-1) encoded byte array,
if Latin-1 is available, otherwise use the default encoding.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/ericsson/otp/erlang/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangShort.html" title="class in com.ericsson.otp.erlang"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ericsson/otp/erlang/OtpErlangTuple.html" title="class in com.ericsson.otp.erlang"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ericsson/otp/erlang/OtpErlangString.html" target="_top">Frames</a></li>
<li><a href="OtpErlangString.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_classes_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Nested</a> | </li>
<li><a href="#fields_inherited_from_class_com.ericsson.otp.erlang.OtpErlangObject">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
