Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / 6ac7d4ae1b4b6520d6919c630b57041cf470bb6d / . / com / intel / jndn / management / EncodingHelper.html
blob: 1ae8fdfba1464f68199bf1c298253312ea69deba [file] [log] [blame]
<!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_51) on Tue Mar 24 09:26:47 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>EncodingHelper (jndn-management 0.9.6 API)</title>
<meta name="date" content="2015-03-24">
<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="EncodingHelper (jndn-management 0.9.6 API)";
}
//-->
</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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EncodingHelper.html">Use</a></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>Prev Class</li>
<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
<li><a href="EncodingHelper.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.intel.jndn.management</div>
<h2 title="Class EncodingHelper" class="title">Class EncodingHelper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.intel.jndn.management.EncodingHelper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">EncodingHelper</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Provide helper methods to cover areas too protected in Tlv0_1_1WireFormat;
this class can be deprecated if WireFormats allow passing in an existing
TlvEncoder/TlvDecoder (currently these methods are protected).</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Andrew Brown <andrew.brown@intel.com></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#EncodingHelper()">EncodingHelper</a></strong>()</code>&nbsp;</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">&nbsp;</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>static net.named_data.jndn.Name</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName(java.nio.ByteBuffer)">decodeName</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)</code>
<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
protected implementation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder)">decodeName</a></strong>(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)</code>
<div class="block">Helper to decode names using an existing decoding context; could be merged
to Tlv0_1_1WireFormat.java.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeControlParameters(net.named_data.jndn.ControlParameters, net.named_data.jndn.encoding.tlv.TlvEncoder)">encodeControlParameters</a></strong>(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
<div class="block">Helper to encode control parameters using an existing encoding context;
could be merged to Tlv0_1_1WireFormat.java.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName(net.named_data.jndn.Name)">encodeName</a></strong>(net.named_data.jndn.Name&nbsp;name)</code>
<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
protected implementation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName(net.named_data.jndn.Name, net.named_data.jndn.encoding.tlv.TlvEncoder)">encodeName</a></strong>(net.named_data.jndn.Name&nbsp;name,
net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
<div class="block">Helper to encode names using an existing encoding context; could be merged
to Tlv0_1_1WireFormat.java.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="EncodingHelper()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EncodingHelper</h4>
<pre>public&nbsp;EncodingHelper()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="decodeName(java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeName</h4>
<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)
throws net.named_data.jndn.encoding.EncodingException</pre>
<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
protected implementation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd></dl>
</li>
</ul>
<a name="decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeName</h4>
<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)
throws net.named_data.jndn.encoding.EncodingException</pre>
<div class="block">Helper to decode names using an existing decoding context; could be merged
to Tlv0_1_1WireFormat.java.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decoder</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd></dl>
</li>
</ul>
<a name="encodeName(net.named_data.jndn.Name)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeName</h4>
<pre>public static&nbsp;net.named_data.jndn.util.Blob&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name)</pre>
<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
protected implementation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
</li>
</ul>
<a name="encodeName(net.named_data.jndn.Name, net.named_data.jndn.encoding.tlv.TlvEncoder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeName</h4>
<pre>public static final&nbsp;void&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name,
net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
<div class="block">Helper to encode names using an existing encoding context; could be merged
to Tlv0_1_1WireFormat.java.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd><dd><code>encoder</code> - </dd></dl>
</li>
</ul>
<a name="encodeControlParameters(net.named_data.jndn.ControlParameters, net.named_data.jndn.encoding.tlv.TlvEncoder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>encodeControlParameters</h4>
<pre>public static final&nbsp;void&nbsp;encodeControlParameters(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
<div class="block">Helper to encode control parameters using an existing encoding context;
could be merged to Tlv0_1_1WireFormat.java.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controlParameters</code> - </dd><dd><code>encoder</code> - </dd></dl>
</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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EncodingHelper.html">Use</a></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>Prev Class</li>
<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
<li><a href="EncodingHelper.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>