Andrew Brown | d4d0eda | 2016-02-22 16:41:07 -0800 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| 2 | <!-- NewPage --> |
| 3 | <html lang="en"> |
| 4 | <head> |
| 5 | <!-- Generated by javadoc (1.8.0_66) on Mon Feb 22 16:40:14 PST 2016 --> |
| 6 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 7 | <title>EncodingHelper (jndn-management 1.1.0 API)</title> |
| 8 | <meta name="date" content="2016-02-22"> |
| 9 | <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| 10 | <script type="text/javascript" src="../../../../../script.js"></script> |
| 11 | </head> |
| 12 | <body> |
| 13 | <script type="text/javascript"><!-- |
| 14 | try { |
| 15 | if (location.href.indexOf('is-external=true') == -1) { |
| 16 | parent.document.title="EncodingHelper (jndn-management 1.1.0 API)"; |
| 17 | } |
| 18 | } |
| 19 | catch(err) { |
| 20 | } |
| 21 | //--> |
| 22 | var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9}; |
| 23 | var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| 24 | var altColor = "altColor"; |
| 25 | var rowColor = "rowColor"; |
| 26 | var tableTab = "tableTab"; |
| 27 | var activeTableTab = "activeTableTab"; |
| 28 | </script> |
| 29 | <noscript> |
| 30 | <div>JavaScript is disabled on your browser.</div> |
| 31 | </noscript> |
| 32 | <!-- ========= START OF TOP NAVBAR ======= --> |
| 33 | <div class="topNav"><a name="navbar.top"> |
| 34 | <!-- --> |
| 35 | </a> |
| 36 | <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| 37 | <a name="navbar.top.firstrow"> |
| 38 | <!-- --> |
| 39 | </a> |
| 40 | <ul class="navList" title="Navigation"> |
| 41 | <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| 42 | <li><a href="package-summary.html">Package</a></li> |
| 43 | <li class="navBarCell1Rev">Class</li> |
| 44 | <li><a href="class-use/EncodingHelper.html">Use</a></li> |
| 45 | <li><a href="package-tree.html">Tree</a></li> |
| 46 | <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| 47 | <li><a href="../../../../../index-all.html">Index</a></li> |
| 48 | <li><a href="../../../../../help-doc.html">Help</a></li> |
| 49 | </ul> |
| 50 | </div> |
| 51 | <div class="subNav"> |
| 52 | <ul class="navList"> |
| 53 | <li>Prev Class</li> |
| 54 | <li><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Next Class</span></a></li> |
| 55 | </ul> |
| 56 | <ul class="navList"> |
| 57 | <li><a href="../../../../../index.html?com/intel/jndn/management/helpers/EncodingHelper.html" target="_top">Frames</a></li> |
| 58 | <li><a href="EncodingHelper.html" target="_top">No Frames</a></li> |
| 59 | </ul> |
| 60 | <ul class="navList" id="allclasses_navbar_top"> |
| 61 | <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| 62 | </ul> |
| 63 | <div> |
| 64 | <script type="text/javascript"><!-- |
| 65 | allClassesLink = document.getElementById("allclasses_navbar_top"); |
| 66 | if(window==top) { |
| 67 | allClassesLink.style.display = "block"; |
| 68 | } |
| 69 | else { |
| 70 | allClassesLink.style.display = "none"; |
| 71 | } |
| 72 | //--> |
| 73 | </script> |
| 74 | </div> |
| 75 | <div> |
| 76 | <ul class="subNavList"> |
| 77 | <li>Summary: </li> |
| 78 | <li>Nested | </li> |
| 79 | <li>Field | </li> |
| 80 | <li>Constr | </li> |
| 81 | <li><a href="#method.summary">Method</a></li> |
| 82 | </ul> |
| 83 | <ul class="subNavList"> |
| 84 | <li>Detail: </li> |
| 85 | <li>Field | </li> |
| 86 | <li>Constr | </li> |
| 87 | <li><a href="#method.detail">Method</a></li> |
| 88 | </ul> |
| 89 | </div> |
| 90 | <a name="skip.navbar.top"> |
| 91 | <!-- --> |
| 92 | </a></div> |
| 93 | <!-- ========= END OF TOP NAVBAR ========= --> |
| 94 | <!-- ======== START OF CLASS DATA ======== --> |
| 95 | <div class="header"> |
| 96 | <div class="subTitle">com.intel.jndn.management.helpers</div> |
| 97 | <h2 title="Class EncodingHelper" class="title">Class EncodingHelper</h2> |
| 98 | </div> |
| 99 | <div class="contentContainer"> |
| 100 | <ul class="inheritance"> |
| 101 | <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| 102 | <li> |
| 103 | <ul class="inheritance"> |
| 104 | <li>com.intel.jndn.management.helpers.EncodingHelper</li> |
| 105 | </ul> |
| 106 | </li> |
| 107 | </ul> |
| 108 | <div class="description"> |
| 109 | <ul class="blockList"> |
| 110 | <li class="blockList"> |
| 111 | <hr> |
| 112 | <br> |
| 113 | <pre>public final class <span class="typeNameLabel">EncodingHelper</span> |
| 114 | extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| 115 | <div class="block">Provide helper methods to cover areas too protected in Tlv0_1_1WireFormat; |
| 116 | this class can be deprecated if WireFormats allow passing in an existing |
| 117 | TlvEncoder/TlvDecoder (currently these methods are protected).</div> |
| 118 | <dl> |
| 119 | <dt><span class="simpleTagLabel">Author:</span></dt> |
| 120 | <dd>Andrew Brown <andrew.brown@intel.com></dd> |
| 121 | </dl> |
| 122 | </li> |
| 123 | </ul> |
| 124 | </div> |
| 125 | <div class="summary"> |
| 126 | <ul class="blockList"> |
| 127 | <li class="blockList"> |
| 128 | <!-- ========== METHOD SUMMARY =========== --> |
| 129 | <ul class="blockList"> |
| 130 | <li class="blockList"><a name="method.summary"> |
| 131 | <!-- --> |
| 132 | </a> |
| 133 | <h3>Method Summary</h3> |
| 134 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| 135 | <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| 136 | <tr> |
| 137 | <th class="colFirst" scope="col">Modifier and Type</th> |
| 138 | <th class="colLast" scope="col">Method and Description</th> |
| 139 | </tr> |
| 140 | <tr id="i0" class="altColor"> |
| 141 | <td class="colFirst"><code>static net.named_data.jndn.Name</code></td> |
| 142 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#decodeName-java.nio.ByteBuffer-">decodeName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> input)</code> |
| 143 | <div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal, |
| 144 | protected implementation.</div> |
| 145 | </td> |
| 146 | </tr> |
| 147 | <tr id="i1" class="rowColor"> |
| 148 | <td class="colFirst"><code>static net.named_data.jndn.Name</code></td> |
| 149 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#decodeName-net.named_data.jndn.encoding.tlv.TlvDecoder-">decodeName</a></span>(net.named_data.jndn.encoding.tlv.TlvDecoder decoder)</code> |
| 150 | <div class="block">Helper to decode names using an existing decoding context; could be merged |
| 151 | to Tlv0_1_1WireFormat.java.</div> |
| 152 | </td> |
| 153 | </tr> |
| 154 | <tr id="i2" class="altColor"> |
| 155 | <td class="colFirst"><code>static net.named_data.jndn.Name</code></td> |
| 156 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#decodeStrategy-java.nio.ByteBuffer-">decodeStrategy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> input)</code> |
| 157 | <div class="block">Helper to decode strategies since Tlv0_1_1WireFormat.java uses its own |
| 158 | internal, protected implementation.</div> |
| 159 | </td> |
| 160 | </tr> |
| 161 | <tr id="i3" class="rowColor"> |
| 162 | <td class="colFirst"><code>static net.named_data.jndn.Name</code></td> |
| 163 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#decodeStrategy-net.named_data.jndn.encoding.tlv.TlvDecoder-">decodeStrategy</a></span>(net.named_data.jndn.encoding.tlv.TlvDecoder decoder)</code> |
| 164 | <div class="block">Helper to decode strategies using an existing decoding context; could be |
| 165 | merged to Tlv0_1_1WireFormat.java.</div> |
| 166 | </td> |
| 167 | </tr> |
| 168 | <tr id="i4" class="altColor"> |
| 169 | <td class="colFirst"><code>static void</code></td> |
| 170 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#encodeControlParameters-net.named_data.jndn.ControlParameters-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeControlParameters</a></span>(net.named_data.jndn.ControlParameters controlParameters, |
| 171 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</code> |
| 172 | <div class="block">Helper to encode control parameters using an existing encoding context; |
| 173 | could be merged to Tlv0_1_1WireFormat.java.</div> |
| 174 | </td> |
| 175 | </tr> |
| 176 | <tr id="i5" class="rowColor"> |
| 177 | <td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td> |
| 178 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#encodeName-net.named_data.jndn.Name-">encodeName</a></span>(net.named_data.jndn.Name name)</code> |
| 179 | <div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal, |
| 180 | protected implementation.</div> |
| 181 | </td> |
| 182 | </tr> |
| 183 | <tr id="i6" class="altColor"> |
| 184 | <td class="colFirst"><code>static void</code></td> |
| 185 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#encodeName-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeName</a></span>(net.named_data.jndn.Name name, |
| 186 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</code> |
| 187 | <div class="block">Helper to encode names using an existing encoding context; could be merged |
| 188 | to Tlv0_1_1WireFormat.java.</div> |
| 189 | </td> |
| 190 | </tr> |
| 191 | <tr id="i7" class="rowColor"> |
| 192 | <td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td> |
| 193 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#encodeStrategy-net.named_data.jndn.Name-">encodeStrategy</a></span>(net.named_data.jndn.Name strategy)</code> |
| 194 | <div class="block">Helper to encode strategies since Tlv0_1_1WireFormat.java uses its own |
| 195 | internal, protected implementation.</div> |
| 196 | </td> |
| 197 | </tr> |
| 198 | <tr id="i8" class="altColor"> |
| 199 | <td class="colFirst"><code>static void</code></td> |
| 200 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#encodeStrategy-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeStrategy</a></span>(net.named_data.jndn.Name strategy, |
| 201 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</code> |
| 202 | <div class="block">Helper to encode strategies using an existing decoding context; could be |
| 203 | merged to Tlv0_1_1WireFormat.java.</div> |
| 204 | </td> |
| 205 | </tr> |
| 206 | <tr id="i9" class="rowColor"> |
| 207 | <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| 208 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/EncodingHelper.html#toString-java.nio.ByteBuffer-">toString</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</code> |
| 209 | <div class="block">Convert ByteBuffer to string, assuming UTF-8 encoding in the buffer.</div> |
| 210 | </td> |
| 211 | </tr> |
| 212 | </table> |
| 213 | <ul class="blockList"> |
| 214 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| 215 | <!-- --> |
| 216 | </a> |
| 217 | <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| 218 | <code><a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| 219 | </ul> |
| 220 | </li> |
| 221 | </ul> |
| 222 | </li> |
| 223 | </ul> |
| 224 | </div> |
| 225 | <div class="details"> |
| 226 | <ul class="blockList"> |
| 227 | <li class="blockList"> |
| 228 | <!-- ============ METHOD DETAIL ========== --> |
| 229 | <ul class="blockList"> |
| 230 | <li class="blockList"><a name="method.detail"> |
| 231 | <!-- --> |
| 232 | </a> |
| 233 | <h3>Method Detail</h3> |
| 234 | <a name="decodeName-java.nio.ByteBuffer-"> |
| 235 | <!-- --> |
| 236 | </a> |
| 237 | <ul class="blockList"> |
| 238 | <li class="blockList"> |
| 239 | <h4>decodeName</h4> |
| 240 | <pre>public static net.named_data.jndn.Name decodeName(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> input) |
| 241 | throws net.named_data.jndn.encoding.EncodingException</pre> |
| 242 | <div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal, |
| 243 | protected implementation.</div> |
| 244 | <dl> |
| 245 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 246 | <dd><code>input</code> - the bytes to decode</dd> |
| 247 | <dt><span class="returnLabel">Returns:</span></dt> |
| 248 | <dd>a decoded <code>Name</code></dd> |
| 249 | <dt><span class="throwsLabel">Throws:</span></dt> |
| 250 | <dd><code>net.named_data.jndn.encoding.EncodingException</code> - when decoding fails</dd> |
| 251 | </dl> |
| 252 | </li> |
| 253 | </ul> |
| 254 | <a name="decodeName-net.named_data.jndn.encoding.tlv.TlvDecoder-"> |
| 255 | <!-- --> |
| 256 | </a> |
| 257 | <ul class="blockList"> |
| 258 | <li class="blockList"> |
| 259 | <h4>decodeName</h4> |
| 260 | <pre>public static net.named_data.jndn.Name decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder decoder) |
| 261 | throws net.named_data.jndn.encoding.EncodingException</pre> |
| 262 | <div class="block">Helper to decode names using an existing decoding context; could be merged |
| 263 | to Tlv0_1_1WireFormat.java.</div> |
| 264 | <dl> |
| 265 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 266 | <dd><code>decoder</code> - a current decoder context to use for decoding</dd> |
| 267 | <dt><span class="returnLabel">Returns:</span></dt> |
| 268 | <dd>a decoded <code>Name</code></dd> |
| 269 | <dt><span class="throwsLabel">Throws:</span></dt> |
| 270 | <dd><code>net.named_data.jndn.encoding.EncodingException</code> - when decoding fails</dd> |
| 271 | </dl> |
| 272 | </li> |
| 273 | </ul> |
| 274 | <a name="encodeName-net.named_data.jndn.Name-"> |
| 275 | <!-- --> |
| 276 | </a> |
| 277 | <ul class="blockList"> |
| 278 | <li class="blockList"> |
| 279 | <h4>encodeName</h4> |
| 280 | <pre>public static net.named_data.jndn.util.Blob encodeName(net.named_data.jndn.Name name)</pre> |
| 281 | <div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal, |
| 282 | protected implementation.</div> |
| 283 | <dl> |
| 284 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 285 | <dd><code>name</code> - the <code>Name</code> to encode</dd> |
| 286 | <dt><span class="returnLabel">Returns:</span></dt> |
| 287 | <dd>an encoded <code>Blob</code></dd> |
| 288 | </dl> |
| 289 | </li> |
| 290 | </ul> |
| 291 | <a name="encodeName-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-"> |
| 292 | <!-- --> |
| 293 | </a> |
| 294 | <ul class="blockList"> |
| 295 | <li class="blockList"> |
| 296 | <h4>encodeName</h4> |
| 297 | <pre>public static void encodeName(net.named_data.jndn.Name name, |
| 298 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</pre> |
| 299 | <div class="block">Helper to encode names using an existing encoding context; could be merged |
| 300 | to Tlv0_1_1WireFormat.java.</div> |
| 301 | <dl> |
| 302 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 303 | <dd><code>name</code> - the <code>Name</code> to encode</dd> |
| 304 | <dd><code>encoder</code> - the current <code>TlvEncoder</code> context to encode with</dd> |
| 305 | </dl> |
| 306 | </li> |
| 307 | </ul> |
| 308 | <a name="decodeStrategy-java.nio.ByteBuffer-"> |
| 309 | <!-- --> |
| 310 | </a> |
| 311 | <ul class="blockList"> |
| 312 | <li class="blockList"> |
| 313 | <h4>decodeStrategy</h4> |
| 314 | <pre>public static net.named_data.jndn.Name decodeStrategy(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> input) |
| 315 | throws net.named_data.jndn.encoding.EncodingException</pre> |
| 316 | <div class="block">Helper to decode strategies since Tlv0_1_1WireFormat.java uses its own |
| 317 | internal, protected implementation.</div> |
| 318 | <dl> |
| 319 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 320 | <dd><code>input</code> - the bytes to decode</dd> |
| 321 | <dt><span class="returnLabel">Returns:</span></dt> |
| 322 | <dd>a decoded <code>Name</code></dd> |
| 323 | <dt><span class="throwsLabel">Throws:</span></dt> |
| 324 | <dd><code>net.named_data.jndn.encoding.EncodingException</code> - when decoding fails</dd> |
| 325 | </dl> |
| 326 | </li> |
| 327 | </ul> |
| 328 | <a name="decodeStrategy-net.named_data.jndn.encoding.tlv.TlvDecoder-"> |
| 329 | <!-- --> |
| 330 | </a> |
| 331 | <ul class="blockList"> |
| 332 | <li class="blockList"> |
| 333 | <h4>decodeStrategy</h4> |
| 334 | <pre>public static net.named_data.jndn.Name decodeStrategy(net.named_data.jndn.encoding.tlv.TlvDecoder decoder) |
| 335 | throws net.named_data.jndn.encoding.EncodingException</pre> |
| 336 | <div class="block">Helper to decode strategies using an existing decoding context; could be |
| 337 | merged to Tlv0_1_1WireFormat.java.</div> |
| 338 | <dl> |
| 339 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 340 | <dd><code>decoder</code> - the current <code>TlvDecoder</code> context to decode with</dd> |
| 341 | <dt><span class="returnLabel">Returns:</span></dt> |
| 342 | <dd>a decoded strategy (e.g. <code>Name</code>)</dd> |
| 343 | <dt><span class="throwsLabel">Throws:</span></dt> |
| 344 | <dd><code>net.named_data.jndn.encoding.EncodingException</code> - when decoding fails</dd> |
| 345 | </dl> |
| 346 | </li> |
| 347 | </ul> |
| 348 | <a name="encodeStrategy-net.named_data.jndn.Name-"> |
| 349 | <!-- --> |
| 350 | </a> |
| 351 | <ul class="blockList"> |
| 352 | <li class="blockList"> |
| 353 | <h4>encodeStrategy</h4> |
| 354 | <pre>public static net.named_data.jndn.util.Blob encodeStrategy(net.named_data.jndn.Name strategy)</pre> |
| 355 | <div class="block">Helper to encode strategies since Tlv0_1_1WireFormat.java uses its own |
| 356 | internal, protected implementation.</div> |
| 357 | <dl> |
| 358 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 359 | <dd><code>strategy</code> - the <code>Name</code> to encode</dd> |
| 360 | <dt><span class="returnLabel">Returns:</span></dt> |
| 361 | <dd>an encoded <code>Blob</code></dd> |
| 362 | </dl> |
| 363 | </li> |
| 364 | </ul> |
| 365 | <a name="encodeStrategy-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-"> |
| 366 | <!-- --> |
| 367 | </a> |
| 368 | <ul class="blockList"> |
| 369 | <li class="blockList"> |
| 370 | <h4>encodeStrategy</h4> |
| 371 | <pre>public static void encodeStrategy(net.named_data.jndn.Name strategy, |
| 372 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</pre> |
| 373 | <div class="block">Helper to encode strategies using an existing decoding context; could be |
| 374 | merged to Tlv0_1_1WireFormat.java.</div> |
| 375 | <dl> |
| 376 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 377 | <dd><code>strategy</code> - the <code>Name</code> to encode</dd> |
| 378 | <dd><code>encoder</code> - the current <code>TlvEncoder</code> context to use</dd> |
| 379 | </dl> |
| 380 | </li> |
| 381 | </ul> |
| 382 | <a name="encodeControlParameters-net.named_data.jndn.ControlParameters-net.named_data.jndn.encoding.tlv.TlvEncoder-"> |
| 383 | <!-- --> |
| 384 | </a> |
| 385 | <ul class="blockList"> |
| 386 | <li class="blockList"> |
| 387 | <h4>encodeControlParameters</h4> |
| 388 | <pre>public static void encodeControlParameters(net.named_data.jndn.ControlParameters controlParameters, |
| 389 | net.named_data.jndn.encoding.tlv.TlvEncoder encoder)</pre> |
| 390 | <div class="block">Helper to encode control parameters using an existing encoding context; |
| 391 | could be merged to Tlv0_1_1WireFormat.java.</div> |
| 392 | <dl> |
| 393 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 394 | <dd><code>controlParameters</code> - control parameters</dd> |
| 395 | <dd><code>encoder</code> - TlvEncoder instance</dd> |
| 396 | </dl> |
| 397 | </li> |
| 398 | </ul> |
| 399 | <a name="toString-java.nio.ByteBuffer-"> |
| 400 | <!-- --> |
| 401 | </a> |
| 402 | <ul class="blockListLast"> |
| 403 | <li class="blockList"> |
| 404 | <h4>toString</h4> |
| 405 | <pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buffer)</pre> |
| 406 | <div class="block">Convert ByteBuffer to string, assuming UTF-8 encoding in the buffer.</div> |
| 407 | <dl> |
| 408 | <dt><span class="paramLabel">Parameters:</span></dt> |
| 409 | <dd><code>buffer</code> - buffer to convert</dd> |
| 410 | <dt><span class="returnLabel">Returns:</span></dt> |
| 411 | <dd>String representation of ByteBuffer (UTF-8 encoding)</dd> |
| 412 | </dl> |
| 413 | </li> |
| 414 | </ul> |
| 415 | </li> |
| 416 | </ul> |
| 417 | </li> |
| 418 | </ul> |
| 419 | </div> |
| 420 | </div> |
| 421 | <!-- ========= END OF CLASS DATA ========= --> |
| 422 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 423 | <div class="bottomNav"><a name="navbar.bottom"> |
| 424 | <!-- --> |
| 425 | </a> |
| 426 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| 427 | <a name="navbar.bottom.firstrow"> |
| 428 | <!-- --> |
| 429 | </a> |
| 430 | <ul class="navList" title="Navigation"> |
| 431 | <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| 432 | <li><a href="package-summary.html">Package</a></li> |
| 433 | <li class="navBarCell1Rev">Class</li> |
| 434 | <li><a href="class-use/EncodingHelper.html">Use</a></li> |
| 435 | <li><a href="package-tree.html">Tree</a></li> |
| 436 | <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| 437 | <li><a href="../../../../../index-all.html">Index</a></li> |
| 438 | <li><a href="../../../../../help-doc.html">Help</a></li> |
| 439 | </ul> |
| 440 | </div> |
| 441 | <div class="subNav"> |
| 442 | <ul class="navList"> |
| 443 | <li>Prev Class</li> |
| 444 | <li><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Next Class</span></a></li> |
| 445 | </ul> |
| 446 | <ul class="navList"> |
| 447 | <li><a href="../../../../../index.html?com/intel/jndn/management/helpers/EncodingHelper.html" target="_top">Frames</a></li> |
| 448 | <li><a href="EncodingHelper.html" target="_top">No Frames</a></li> |
| 449 | </ul> |
| 450 | <ul class="navList" id="allclasses_navbar_bottom"> |
| 451 | <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| 452 | </ul> |
| 453 | <div> |
| 454 | <script type="text/javascript"><!-- |
| 455 | allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 456 | if(window==top) { |
| 457 | allClassesLink.style.display = "block"; |
| 458 | } |
| 459 | else { |
| 460 | allClassesLink.style.display = "none"; |
| 461 | } |
| 462 | //--> |
| 463 | </script> |
| 464 | </div> |
| 465 | <div> |
| 466 | <ul class="subNavList"> |
| 467 | <li>Summary: </li> |
| 468 | <li>Nested | </li> |
| 469 | <li>Field | </li> |
| 470 | <li>Constr | </li> |
| 471 | <li><a href="#method.summary">Method</a></li> |
| 472 | </ul> |
| 473 | <ul class="subNavList"> |
| 474 | <li>Detail: </li> |
| 475 | <li>Field | </li> |
| 476 | <li>Constr | </li> |
| 477 | <li><a href="#method.detail">Method</a></li> |
| 478 | </ul> |
| 479 | </div> |
| 480 | <a name="skip.navbar.bottom"> |
| 481 | <!-- --> |
| 482 | </a></div> |
| 483 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 484 | <p class="legalCopy"><small>Copyright © 2016. All rights reserved.</small></p> |
| 485 | </body> |
| 486 | </html> |