| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>DecodeException</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DecodeException"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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="../../javax/websocket/ContainerProvider.html" title="class in javax.websocket"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/websocket/Decoder.html" title="interface in javax.websocket"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/websocket/DecodeException.html" target="_top">Frames</a></li> |
| <li><a href="DecodeException.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>Nested | </li> |
| <li>Field | </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">javax.websocket</div> |
| <h2 title="Class DecodeException" class="title">Class DecodeException</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Throwable</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Exception</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.websocket.DecodeException</li> |
| </ul> |
| </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</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">DecodeException</span> |
| extends java.lang.Exception</pre> |
| <div class="block">A general exception that occurs when trying to decode a custom object from a text or binary message.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../serialized-form.html#javax.websocket.DecodeException">Serialized Form</a></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="memberSummary" 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><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#DecodeException-java.nio.ByteBuffer-java.lang.String-">DecodeException</a></span>(java.nio.ByteBuffer bb, |
| java.lang.String message)</code> |
| <div class="block">Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#DecodeException-java.nio.ByteBuffer-java.lang.String-java.lang.Throwable-">DecodeException</a></span>(java.nio.ByteBuffer bb, |
| java.lang.String message, |
| java.lang.Throwable cause)</code> |
| <div class="block">Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#DecodeException-java.lang.String-java.lang.String-">DecodeException</a></span>(java.lang.String encodedString, |
| java.lang.String message)</code> |
| <div class="block">Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#DecodeException-java.lang.String-java.lang.String-java.lang.Throwable-">DecodeException</a></span>(java.lang.String encodedString, |
| java.lang.String message, |
| java.lang.Throwable cause)</code> |
| <div class="block">Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.nio.ByteBuffer</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#getBytes--">getBytes</a></span>()</code> |
| <div class="block">Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, or |
| <code>null</code> if this exception arose from a failure to decode a text message.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../javax/websocket/DecodeException.html#getText--">getText</a></span>()</code> |
| <div class="block">Return the encoded string that is either the whole message, or the partial message that could not be decoded, or |
| <code>null</code> if this exception arose from a failure to decode a binary message..</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Throwable</h3> |
| <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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>clone, equals, finalize, getClass, hashCode, 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="DecodeException-java.nio.ByteBuffer-java.lang.String-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DecodeException</h4> |
| <pre>public DecodeException(java.nio.ByteBuffer bb, |
| java.lang.String message, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Constructor with the binary data that could not be decoded, and the reason why it failed to be, and the cause. |
| The buffer may represent the whole message, or the part of the message most relevant to the decoding error, |
| depending whether the application is using one of the streaming methods or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bb</code> - the byte buffer containing the (part of) the message that could not be decoded.</dd> |
| <dd><code>message</code> - the reason for the failure.</dd> |
| <dd><code>cause</code> - the cause of the error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DecodeException-java.lang.String-java.lang.String-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DecodeException</h4> |
| <pre>public DecodeException(java.lang.String encodedString, |
| java.lang.String message, |
| java.lang.Throwable cause)</pre> |
| <div class="block">Constructor with the text data that could not be decoded, and the reason why it failed to be, and the cause. The |
| encoded string may represent the whole message, or the part of the message most relevant to the decoding error, |
| depending whether the application is using one of the streaming methods or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedString</code> - the string representing the (part of) the message that could not be decoded.</dd> |
| <dd><code>message</code> - the reason for the failure.</dd> |
| <dd><code>cause</code> - the cause of the error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DecodeException-java.nio.ByteBuffer-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DecodeException</h4> |
| <pre>public DecodeException(java.nio.ByteBuffer bb, |
| java.lang.String message)</pre> |
| <div class="block">Constructs a DecodedException with the given ByteBuffer that cannot be decoded, and reason why. The buffer may |
| represent the whole message, or the part of the message most relevant to the decoding error, depending whether |
| the application is using one of the streaming methods or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bb</code> - the byte buffer containing the (part of) the message that could not be decoded.</dd> |
| <dd><code>message</code> - the reason for the failure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DecodeException-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DecodeException</h4> |
| <pre>public DecodeException(java.lang.String encodedString, |
| java.lang.String message)</pre> |
| <div class="block">Constructs a DecodedException with the given encoded string that cannot be decoded, and reason why. The encoded |
| string may represent the whole message, or the part of the message most relevant to the decoding error, depending |
| whether the application is using one of the streaming methods or not.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encodedString</code> - the string representing the (part of) the message that could not be decoded.</dd> |
| <dd><code>message</code> - the reason for the failure.</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="getBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBytes</h4> |
| <pre>public java.nio.ByteBuffer getBytes()</pre> |
| <div class="block">Return the ByteBuffer containing either the whole message, or the partial message, that could not be decoded, or |
| <code>null</code> if this exception arose from a failure to decode a text message.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the binary data not decoded or <code>null</code> for text message failures.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getText--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getText</h4> |
| <pre>public java.lang.String getText()</pre> |
| <div class="block">Return the encoded string that is either the whole message, or the partial message that could not be decoded, or |
| <code>null</code> if this exception arose from a failure to decode a binary message..</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the text not decoded or <code>null</code> for binary message failures.</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="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="../../javax/websocket/ContainerProvider.html" title="class in javax.websocket"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../javax/websocket/Decoder.html" title="interface in javax.websocket"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?javax/websocket/DecodeException.html" target="_top">Frames</a></li> |
| <li><a href="DecodeException.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>Nested | </li> |
| <li>Field | </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> |
