Skip to content

Commit

Permalink
Deploying to javadoc from @ 73d1b9c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
lcereser6 committed Aug 10, 2024
1 parent 4cc9486 commit 53e3978
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 8 deletions.
12 changes: 12 additions & 0 deletions javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,10 @@ <h2 class="title" id="I:M">M</h2>
<dd>
<div class="block">Creates an instance of a <code>MakeRequest</code> record class.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.html#matchNodeID(akka.actor.ActorRef)" class="member-name-link">matchNodeID(ActorRef)</a> - Static method in class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.html" title="class in it.unitn.disi.ds1.qtop">Utils</a></dt>
<dd>
<div class="block">Method to match the ID of a node and build a fancy string out of it.</div>
</dd>
</dl>
<h2 class="title" id="I:N">N</h2>
<dl class="index">
Expand Down Expand Up @@ -531,6 +535,10 @@ <h2 class="title" id="I:N">N</h2>
<dd>
<div class="block">Constructor for the Node class.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#NODE_AFTER_ELECTION_MESSAGE" class="member-name-link">NODE_AFTER_ELECTION_MESSAGE</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
<dd>
<div class="block">Receiver crash after a node sends an Election message.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#NODE_AFTER_VOTE_CAST" class="member-name-link">NODE_AFTER_VOTE_CAST</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
<dd>
<div class="block">Receiver crash after casting a vote.</div>
Expand All @@ -543,6 +551,10 @@ <h2 class="title" id="I:N">N</h2>
<dd>
<div class="block">Receiver crash after propagating a write request.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#NODE_BEFORE_ELECTION_ACK" class="member-name-link">NODE_BEFORE_ELECTION_ACK</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
<dd>
<div class="block">Receiver crash when a node receives an election message.</div>
</dd>
<dt><a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html#NODE_BEFORE_WRITE_REQUEST" class="member-name-link">NODE_BEFORE_WRITE_REQUEST</a> - Enum constant in enum class it.unitn.disi.ds1.qtop.<a href="it/unitn/disi/ds1/qtop/Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></dt>
<dd>
<div class="block">Receiver crash before propagating a write request.</div>
Expand Down
33 changes: 28 additions & 5 deletions javadoc/it/unitn/disi/ds1/qtop/Utils.CrashType.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,18 +133,26 @@ <h2>Enum Constant Summary</h2>
<div class="col-last even-row-color">
<div class="block">No crash.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#NODE_AFTER_VOTE_CAST" class="member-name-link">NODE_AFTER_VOTE_CAST</a></code></div>
<div class="col-first odd-row-color"><code><a href="#NODE_AFTER_ELECTION_MESSAGE" class="member-name-link">NODE_AFTER_ELECTION_MESSAGE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Receiver crash after casting a vote.</div>
<div class="block">Receiver crash after a node sends an Election message.</div>
</div>
<div class="col-first even-row-color"><code><a href="#NODE_AFTER_VOTE_REQUEST" class="member-name-link">NODE_AFTER_VOTE_REQUEST</a></code></div>
<div class="col-first even-row-color"><code><a href="#NODE_AFTER_VOTE_CAST" class="member-name-link">NODE_AFTER_VOTE_CAST</a></code></div>
<div class="col-last even-row-color">
<div class="block">Receiver crash after receiving a vote request.</div>
<div class="block">Receiver crash after casting a vote.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#NODE_AFTER_WRITE_REQUEST" class="member-name-link">NODE_AFTER_WRITE_REQUEST</a></code></div>
<div class="col-first odd-row-color"><code><a href="#NODE_AFTER_VOTE_REQUEST" class="member-name-link">NODE_AFTER_VOTE_REQUEST</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Receiver crash after receiving a vote request.</div>
</div>
<div class="col-first even-row-color"><code><a href="#NODE_AFTER_WRITE_REQUEST" class="member-name-link">NODE_AFTER_WRITE_REQUEST</a></code></div>
<div class="col-last even-row-color">
<div class="block">Receiver crash after propagating a write request.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#NODE_BEFORE_ELECTION_ACK" class="member-name-link">NODE_BEFORE_ELECTION_ACK</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Receiver crash when a node receives an election message.</div>
</div>
<div class="col-first even-row-color"><code><a href="#NODE_BEFORE_WRITE_REQUEST" class="member-name-link">NODE_BEFORE_WRITE_REQUEST</a></code></div>
<div class="col-last even-row-color">
<div class="block">Receiver crash before propagating a write request.</div>
Expand Down Expand Up @@ -230,6 +238,21 @@ <h3>NODE_AFTER_VOTE_CAST</h3>
</section>
</li>
<li>
<section class="detail" id="NODE_BEFORE_ELECTION_ACK">
<h3>NODE_BEFORE_ELECTION_ACK</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></span>&nbsp;<span class="element-name">NODE_BEFORE_ELECTION_ACK</span></div>
<div class="block">Receiver crash when a node receives an election message.
Does NOT reply with an ACK</div>
</section>
</li>
<li>
<section class="detail" id="NODE_AFTER_ELECTION_MESSAGE">
<h3>NODE_AFTER_ELECTION_MESSAGE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></span>&nbsp;<span class="element-name">NODE_AFTER_ELECTION_MESSAGE</span></div>
<div class="block">Receiver crash after a node sends an Election message.</div>
</section>
</li>
<li>
<section class="detail" id="COORDINATOR_ON_VOTE_REQUEST">
<h3>COORDINATOR_ON_VOTE_REQUEST</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="Utils.CrashType.html" title="enum class in it.unitn.disi.ds1.qtop">Utils.CrashType</a></span>&nbsp;<span class="element-name">COORDINATOR_ON_VOTE_REQUEST</span></div>
Expand Down
45 changes: 43 additions & 2 deletions javadoc/it/unitn/disi/ds1/qtop/Utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li>Method</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
Expand All @@ -65,7 +65,7 @@
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
Expand Down Expand Up @@ -248,6 +248,21 @@ <h2>Constructor Summary</h2>
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#matchNodeID(akka.actor.ActorRef)" class="member-name-link">matchNodeID</a><wbr>(akka.actor.ActorRef&nbsp;actorRefToMatch)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Method to match the ID of a node and build a fancy string out of it.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
Expand All @@ -271,6 +286,32 @@ <h3>Utils</h3>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="matchNodeID(akka.actor.ActorRef)">
<h3>matchNodeID</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">matchNodeID</span><wbr><span class="parameters">(akka.actor.ActorRef&nbsp;actorRefToMatch)</span></div>
<div class="block">Method to match the ID of a node and build a fancy string out of it.
There are two cases:
<ul>
<li> if the actor reference is a node, it will return [NODE-xyz]
<li> if the actor reference is the coordinator, it will return [COORDINATOR]
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>actorRefToMatch</code> - the actor reference to match</dd>
<dt>Returns:</dt>
<dd>the fancy String.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
Expand Down
Loading

0 comments on commit 53e3978

Please sign in to comment.