alfred/calmnetlib
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity
6edf85ce51
calmnetlib/JavaDoc/com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html

415 lines
18 KiB
HTML
Raw Normal View History

Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<!-- Generated by javadoc (1.8.0_262) on Sun Jun 11 02:31:49 BST 2023 -->
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<title>FragmentPIDMSGPacket</title>
Allow integer to bytes writing in PacketLoader to support negatives. Fix up JavaDoc.
2023-06-11 02:54:23 +01:00
<meta name="date" content="2023-06-11">
Add build artifact and JavaDoc.
2023-05-23 15:24:10 +01:00
<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="FragmentPIDMSGPacket";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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-files/index-1.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/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDMSGPacket.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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.captainalm.lib.calmnet.packet.fragment</div>
<h2 title="Class FragmentPIDMSGPacket" class="title">Class FragmentPIDMSGPacket</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket</a></li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.calmnet.packet.fragment.FragmentPIDMSGPacket</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessagePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessagePacket</a>, <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentMessageResponsePacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentMessageResponsePacket</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">FragmentPIDMSGPacket</span>
extends <a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></pre>
<div class="block">This abstract base class provides the ability for packets to contain an ID, a Fragment ID and a payload.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Captain ALM</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">&nbsp;</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="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#FragmentPIDMSGPacket-java.lang.Integer-java.lang.Integer-byte:A-">FragmentPIDMSGPacket</a></span>(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</code>
<div class="block">Constructs a new FragmentPIDMSGPacket given the packet ID, fragment ID and payload.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentID--">getFragmentID</a></span>()</code>
<div class="block">Gets the fragment ID or null.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#getFragmentMessage--">getFragmentMessage</a></span>()</code>
<div class="block">Gets the fragment message byte array or null.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#isValid--">isValid</a></span>()</code>
<div class="block">Gets if the packet is valid.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#loadPayload-byte:A-">loadPayload</a></span>(byte[]&nbsp;packetData)</code>
<div class="block">Loads the packet payload from save data.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html#savePayload--">savePayload</a></span>()</code>
<div class="block">Saves the packet payload to a byte array.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.fragment.FragmentPIDPacket">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.captainalm.lib.calmnet.packet.fragment.<a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></h3>
<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#getPacketID--">getPacketID</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&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.captainalm.lib.calmnet.packet.IPacket">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.captainalm.lib.calmnet.packet.<a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></h3>
<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#getProtocol--">getProtocol</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="FragmentPIDMSGPacket-java.lang.Integer-java.lang.Integer-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FragmentPIDMSGPacket</h4>
<pre>public&nbsp;FragmentPIDMSGPacket(java.lang.Integer&nbsp;packetID,
java.lang.Integer&nbsp;fragmentID,
byte[]&nbsp;payload)</pre>
<div class="block">Constructs a new FragmentPIDMSGPacket given the packet ID, fragment ID and payload.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetID</code> - The packet ID.</dd>
<dd><code>fragmentID</code> - The fragment ID.</dd>
<dd><code>payload</code> - The payload to store.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - packetID or fragmentID is less than 0.</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="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public&nbsp;boolean&nbsp;isValid()</pre>
<div class="block">Gets if the packet is valid.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html#isValid--">isValid</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title="interface in com.captainalm.lib.calmnet.packet">IPacket</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html#isValid--">isValid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment">FragmentPIDPacket</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Is the packet valid?</dd>
</dl>
</li>
</ul>
<a name="savePayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>savePayload</h4>
<pre>public&nbsp;byte[]&nbsp;savePayload()
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Saves the packet payload to a byte array.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="loadPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPayload</h4>
<pre>public&nbsp;void&nbsp;loadPayload(byte[]&nbsp;packetData)
throws <a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></pre>
<div class="block">Loads the packet payload from save data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>packetData</code> - The packet payload data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - The new store data is null.</dd>
<dd><code><a href="../../../../../../com/captainalm/lib/calmnet/packet/PacketException.html" title="class in com.captainalm.lib.calmnet.packet">PacketException</a></code> - An Exception has occurred.</dd>
</dl>
</li>
</ul>
<a name="getFragmentMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFragmentMessage</h4>
<pre>public&nbsp;byte[]&nbsp;getFragmentMessage()</pre>
<div class="block">Gets the fragment message byte array or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The byte array or null.</dd>
</dl>
</li>
</ul>
<a name="getFragmentID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFragmentID</h4>
<pre>public&nbsp;java.lang.Integer&nbsp;getFragmentID()</pre>
<div class="block">Gets the fragment ID or null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The fragment ID or null.</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-files/index-1.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/captainalm/lib/calmnet/packet/fragment/FragmentPIDAKNPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../com/captainalm/lib/calmnet/packet/fragment/FragmentPIDPacket.html" title="class in com.captainalm.lib.calmnet.packet.fragment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/captainalm/lib/calmnet/packet/fragment/FragmentPIDMSGPacket.html" target="_top">Frames</a></li>
<li><a href="FragmentPIDMSGPacket.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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 ======= -->
</body>
</html>
Reference in New Issue Copy Permalink