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 >
2023-06-11 02:54:23 +01:00
<!-- Generated by javadoc (1.8.0_262) on Sun Jun 11 02:31:49 BST 2023 -->
2023-05-23 15:24:10 +01:00
< title > PacketProtocolInformation< / title >
2023-06-11 02:54:23 +01:00
< meta name = "date" content = "2023-06-11" >
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="PacketProtocolInformation";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/PacketLoader.html" title = "class in com.captainalm.lib.calmnet.packet" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "PacketProtocolInformation.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" > com.captainalm.lib.calmnet.packet< / div >
< h2 title = "Class PacketProtocolInformation" class = "title" > Class PacketProtocolInformation< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > com.captainalm.lib.calmnet.packet.PacketProtocolInformation< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< br >
< pre > public class < span class = "typeNameLabel" > PacketProtocolInformation< / span >
extends java.lang.Object< / pre >
< div class = "block" > This class provides the packet protocol information for < a href = "../../../../../com/captainalm/lib/calmnet/packet/IPacket.html" title = "interface in com.captainalm.lib.calmnet.packet" > < code > IPacket< / code > < / a > .< / 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" > < / 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/PacketProtocolInformation.html#PacketProtocolInformation--" > PacketProtocolInformation< / a > < / span > ()< / code >
< div class = "block" > Constructs a new instance of PacketProtocolInformation.< / div >
< / td >
< / tr >
< tr class = "rowColor" >
< td class = "colOne" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#PacketProtocolInformation-byte-byte-" > PacketProtocolInformation< / a > < / span > (byte major,
byte minor)< / code >
< div class = "block" > Constructs a new instance of PacketProtocolInformation.< / 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 = "t1" class = "tableTab" > < span > < a href = "javascript:show(1);" > Static Methods< / a > < / 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 > boolean< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#equals-java.lang.Object-" > equals< / a > < / span > (java.lang.Object o)< / code >
< div class = "block" > Gets whether this object equals the passed object.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMajor--" > getMajor< / a > < / span > ()< / code >
< div class = "block" > Gets the major protocol for the packet.< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getMinor--" > getMinor< / a > < / span > ()< / code >
< div class = "block" > Gets the minor protocol for the packet.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > static < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > PacketProtocolInformation< / a > < / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#getProtocolInformation-java.io.InputStream-" > getProtocolInformation< / a > < / span > (java.io.InputStream inputStream)< / code >
< div class = "block" > Gets the < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > < code > PacketProtocolInformation< / code > < / a > of the packet.< / div >
< / td >
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > int< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#hashCode--" > hashCode< / a > < / span > ()< / code >
< div class = "block" > Gets the hash code of the object.< / div >
< / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > static void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html#savePacketProtocolInformation-java.io.OutputStream-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-" > savePacketProtocolInformation< / a > < / span > (java.io.OutputStream outputStream,
< a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > PacketProtocolInformation< / a > information)< / code >
< div class = "block" > Saves the < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > < code > PacketProtocolInformation< / code > < / a > of the packet.< / 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 java.lang.Object< / h3 >
< code > getClass, notify, notifyAll, toString, 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 = "PacketProtocolInformation--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > PacketProtocolInformation< / h4 >
< pre > public PacketProtocolInformation()< / pre >
< div class = "block" > Constructs a new instance of PacketProtocolInformation.
This is set to 0 Major, 0 Minor.< / div >
< / li >
< / ul >
< a name = "PacketProtocolInformation-byte-byte-" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > PacketProtocolInformation< / h4 >
< pre > public PacketProtocolInformation(byte major,
byte minor)< / pre >
< div class = "block" > Constructs a new instance of PacketProtocolInformation.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > major< / code > - The major version.< / dd >
< dd > < code > minor< / code > - The minor version.< / 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 = "getMajor--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getMajor< / h4 >
< pre > public int getMajor()< / pre >
< div class = "block" > Gets the major protocol for the packet.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > The major protocol.< / dd >
< / dl >
< / li >
< / ul >
< a name = "getMinor--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getMinor< / h4 >
< pre > public int getMinor()< / pre >
< div class = "block" > Gets the minor protocol for the packet.< / div >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > The minor protocol.< / dd >
< / dl >
< / li >
< / ul >
< a name = "getProtocolInformation-java.io.InputStream-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getProtocolInformation< / h4 >
< pre > public static < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > PacketProtocolInformation< / a > getProtocolInformation(java.io.InputStream inputStream)
throws java.io.IOException< / pre >
< div class = "block" > Gets the < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > < code > PacketProtocolInformation< / code > < / a > of the packet.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > inputStream< / code > - The input stream for reading.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > The protocol information.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.NullPointerException< / code > - The inputStream is null.< / dd >
< dd > < code > java.io.IOException< / code > - A stream exception occurs.< / dd >
< / dl >
< / li >
< / ul >
< a name = "savePacketProtocolInformation-java.io.OutputStream-com.captainalm.lib.calmnet.packet.PacketProtocolInformation-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > savePacketProtocolInformation< / h4 >
< pre > public static void savePacketProtocolInformation(java.io.OutputStream outputStream,
< a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > PacketProtocolInformation< / a > information)
throws java.io.IOException< / pre >
< div class = "block" > Saves the < a href = "../../../../../com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" title = "class in com.captainalm.lib.calmnet.packet" > < code > PacketProtocolInformation< / code > < / a > of the packet.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > outputStream< / code > - The output stream for writing.< / dd >
< dd > < code > information< / code > - The protocol information.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.NullPointerException< / code > - A parameter is null.< / dd >
< dd > < code > java.io.IOException< / code > - A stream exception occurs.< / 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" > Gets whether this object equals the passed object.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > equals< / code > in class < code > java.lang.Object< / code > < / dd >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > o< / code > - The object to check.< / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > If the objects are equivalent.< / dd >
< / dl >
< / li >
< / ul >
< a name = "hashCode--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > hashCode< / h4 >
< pre > public int hashCode()< / pre >
< div class = "block" > Gets the hash code of the object.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Overrides:< / span > < / dt >
< dd > < code > hashCode< / code > in class < code > java.lang.Object< / code > < / dd >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > The hash code of the object.< / 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/PacketLoader.html" title = "class in com.captainalm.lib.calmnet.packet" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > Next Class< / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../../index.html?com/captainalm/lib/calmnet/packet/PacketProtocolInformation.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "PacketProtocolInformation.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 >
