pfaure/BE-Graphes
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
BE-Graphes/Documentation/org/insa/graphs/model/io/BinaryReader.html

580 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="fr">
<head>
<!-- Generated by javadoc (11.0.6) on Mon Mar 16 10:16:49 CET 2020 -->
<title>BinaryReader</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-03-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BinaryReader";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BinaryReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.insa.graphs.model.io</a></div>
<h2 title="Class BinaryReader" class="title">Class BinaryReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.insa.graphs.model.io.BinaryReader</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Closeable</code>, <code>java.lang.AutoCloseable</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="BinaryGraphReader.html" title="class in org.insa.graphs.model.io">BinaryGraphReader</a></code>, <code><a href="BinaryPathReader.html" title="class in org.insa.graphs.model.io">BinaryPathReader</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">BinaryReader</span>
extends java.lang.Object
implements java.lang.AutoCloseable, java.io.Closeable</pre>
<div class="block">Base class for writing binary file.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#curVersion">curVersion</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.DataInputStream</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dis">dis</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#magicNumber">magicNumber</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minVersion">minVersion</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(int,int,java.io.DataInputStream)">BinaryReader</a></span>&#8203;(int&nbsp;magicNumber,
int&nbsp;minVersion,
java.io.DataInputStream&nbsp;dis)</code></th>
<td class="colLast">
<div class="block">Create a new BinaryReader that reads from the given stream and that expected
the given magic number and at least the given minimum version.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkByteOrThrow(int)">checkByteOrThrow</a></span>&#8203;(int&nbsp;b)</code></th>
<td class="colLast">
<div class="block">Check if the next byte in the input stream correspond to the given byte.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkMagicNumberOrThrow(int)">checkMagicNumberOrThrow</a></span>&#8203;(int&nbsp;magicNumber)</code></th>
<td class="colLast">
<div class="block">Check if the given number matches the expected magic number.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkVersionOrThrow(int)">checkVersionOrThrow</a></span>&#8203;(int&nbsp;version)</code></th>
<td class="colLast">
<div class="block">Check if the given version is greater than the minimum version, and update
the current version if it is.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentVersion()">getCurrentVersion</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#read24bits()">read24bits</a></span>()</code></th>
<td class="colLast">
<div class="block">Read 24 bits in BigEndian order from the stream and return the corresponding
integer value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readFixedLengthString(int,java.lang.String)">readFixedLengthString</a></span>&#8203;(int&nbsp;length,
java.lang.String&nbsp;charset)</code></th>
<td class="colLast">
<div class="block">Read a byte array of fixed length from the input and convert it to a string
using the given charset, removing any trailing '\0'.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="minVersion">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minVersion</h4>
<pre>private final&nbsp;int minVersion</pre>
</li>
</ul>
<a id="curVersion">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>curVersion</h4>
<pre>private&nbsp;int curVersion</pre>
</li>
</ul>
<a id="magicNumber">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>magicNumber</h4>
<pre>private final&nbsp;int magicNumber</pre>
</li>
</ul>
<a id="dis">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dis</h4>
<pre>protected final&nbsp;java.io.DataInputStream dis</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(int,int,java.io.DataInputStream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BinaryReader</h4>
<pre>protected&nbsp;BinaryReader&#8203;(int&nbsp;magicNumber,
int&nbsp;minVersion,
java.io.DataInputStream&nbsp;dis)</pre>
<div class="block">Create a new BinaryReader that reads from the given stream and that expected
the given magic number and at least the given minimum version.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>magicNumber</code> - Magic number of files to be read.</dd>
<dd><code>minVersion</code> - Minimum version of files to be read.</dd>
<dd><code>dis</code> - Input stream from which to read.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="checkVersionOrThrow(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkVersionOrThrow</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkVersionOrThrow&#8203;(int&nbsp;version)
throws <a href="BadVersionException.html" title="class in org.insa.graphs.model.io">BadVersionException</a></pre>
<div class="block">Check if the given version is greater than the minimum version, and update
the current version if it is.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>version</code> - Version to check.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="BadVersionException.html" title="class in org.insa.graphs.model.io">BadVersionException</a></code> - if the given version is not greater than the
minimum version.</dd>
</dl>
</li>
</ul>
<a id="getCurrentVersion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentVersion</h4>
<pre class="methodSignature">protected&nbsp;int&nbsp;getCurrentVersion()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current version.</dd>
</dl>
</li>
</ul>
<a id="checkMagicNumberOrThrow(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkMagicNumberOrThrow</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkMagicNumberOrThrow&#8203;(int&nbsp;magicNumber)
throws <a href="BadMagicNumberException.html" title="class in org.insa.graphs.model.io">BadMagicNumberException</a></pre>
<div class="block">Check if the given number matches the expected magic number.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>magicNumber</code> - The magic number to check.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="BadMagicNumberException.html" title="class in org.insa.graphs.model.io">BadMagicNumberException</a></code> - If the two magic numbers are not equal.</dd>
</dl>
</li>
</ul>
<a id="checkByteOrThrow(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkByteOrThrow</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;checkByteOrThrow&#8203;(int&nbsp;b)
throws java.io.IOException</pre>
<div class="block">Check if the next byte in the input stream correspond to the given byte.
This function consumes the next byte in the input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>b</code> - Byte to check.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs while reading the byte.</dd>
<dd><code><a href="BadFormatException.html" title="class in org.insa.graphs.model.io">BadFormatException</a></code> - if the byte read is not the expected one.</dd>
</dl>
</li>
</ul>
<a id="readFixedLengthString(int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFixedLengthString</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;readFixedLengthString&#8203;(int&nbsp;length,
java.lang.String&nbsp;charset)
throws java.io.IOException</pre>
<div class="block">Read a byte array of fixed length from the input and convert it to a string
using the given charset, removing any trailing '\0'.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>length</code> - Number of bytes to read.</dd>
<dd><code>charset</code> - Charset to use to convert the bytes into a string.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The convert string.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs while reading or converting.</dd>
</dl>
</li>
</ul>
<a id="read24bits()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>read24bits</h4>
<pre class="methodSignature">protected&nbsp;int&nbsp;read24bits()
throws java.io.IOException</pre>
<div class="block">Read 24 bits in BigEndian order from the stream and return the corresponding
integer value.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Integer value read from the next 24 bits of the stream.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs while reading from the stream.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BinaryReader.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in a new issue View git blame Copy permalink