Skip to content

Commit

Permalink
use enums for constants
Browse files Browse the repository at this point in the history
  • Loading branch information
@terrywbrady
terrywbrady committed Apr 26, 2024
1 parent 8723f5a commit 9334c33
Show file tree
Hide file tree
Showing 37 changed files with 2,551 additions and 407 deletions.
38 changes: 25 additions & 13 deletions api/java/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":2,"i1":4,"i2":2,"i3":4,"i4":1,"i5":2,"i6":4,"i7":4,"i8":2,"i9":8,"i10":8,"i11":2,"i12":2,"i13":4};
var data = {"i0":2,"i1":4,"i2":4,"i3":2,"i4":4,"i5":1,"i6":2,"i7":4,"i8":4,"i9":2,"i10":8,"i11":8,"i12":2,"i13":4,"i14":4,"i15":2,"i16":4};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -117,76 +117,88 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/Access.Queues.html" title="enum in org.cdlib.mrt.zk">Access.Queues</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/AccessState.html" title="enum in org.cdlib.mrt.zk">AccessState</a></td>
<th class="colLast" scope="row">
<div class="block">Access Assembly State Transitions</div>
</th>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/Batch.html" title="class in org.cdlib.mrt.zk">Batch</a></td>
<th class="colLast" scope="row">
<div class="block">Class to manage a Merritt Ingest Batch in the Batch Queue.</div>
</th>
</tr>
<tr id="i3" class="rowColor">
<tr id="i4" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/BatchState.html" title="enum in org.cdlib.mrt.zk">BatchState</a></td>
<th class="colLast" scope="row">
<div class="block">Batch State Transitions</div>
</th>
</tr>
<tr id="i4" class="altColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/IngestState.html" title="interface in org.cdlib.mrt.zk">IngestState</a></td>
<th class="colLast" scope="row">
<div class="block">Common interface for Ingest Queue State Enums</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<tr id="i6" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/Job.html" title="class in org.cdlib.mrt.zk">Job</a></td>
<th class="colLast" scope="row">
<div class="block">Class to manage a Merritt Ingest Job in the Job Queue.</div>
</th>
</tr>
<tr id="i6" class="altColor">
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/JobState.html" title="enum in org.cdlib.mrt.zk">JobState</a></td>
<th class="colLast" scope="row">
<div class="block">Job State Transitions</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<tr id="i8" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/MerrittJsonKey.html" title="enum in org.cdlib.mrt.zk">MerrittJsonKey</a></td>
<th class="colLast" scope="row">
<div class="block">Lookup key names for properties stored as JSON within ZooKeeper nodes.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/MerrittLocks.html" title="class in org.cdlib.mrt.zk">MerrittLocks</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i9" class="rowColor">
<tr id="i10" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/MerrittStateError.html" title="class in org.cdlib.mrt.zk">MerrittStateError</a></td>
<th class="colLast" scope="row">
<div class="block">Exception indicates that an illegal operation was invoked on an object with an incompatible state (ie attempting to delete a Job or Batch that is not in a deleteable state)</div>
</th>
</tr>
<tr id="i10" class="altColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/MerrittZKNodeInvalid.html" title="class in org.cdlib.mrt.zk">MerrittZKNodeInvalid</a></td>
<th class="colLast" scope="row">
<div class="block">Exception thown when attempting to modify the data payload for a ZooKeeper node.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<tr id="i12" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/QueueItem.html" title="class in org.cdlib.mrt.zk">QueueItem</a></td>
<th class="colLast" scope="row">
<div class="block">Base Class for Common functions for Merritt Ingest Batches and Merritt Ingest Jobs.</div>
</th>
</tr>
<tr id="i12" class="altColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/QueueItem.ZkPaths.html" title="enum in org.cdlib.mrt.zk">QueueItem.ZkPaths</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/QueueItem.ZkPrefixes.html" title="enum in org.cdlib.mrt.zk">QueueItem.ZkPrefixes</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/QueueItemHelper.html" title="class in org.cdlib.mrt.zk">QueueItemHelper</a></td>
<th class="colLast" scope="row">
<div class="block">The static methods in this class also provides a simplified interface for common ZooKeeper API calls.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<tr id="i16" class="altColor">
<td class="colFirst"><a href="org/cdlib/mrt/zk/ZKKey.html" title="enum in org.cdlib.mrt.zk">ZKKey</a></td>
<th class="colLast" scope="row">
<div class="block">Defines relative pathnames to ZooKeeper nodes for a Batch or a Job.</div>
Expand Down
3 changes: 3 additions & 0 deletions api/java/allclasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="org/cdlib/mrt/zk/Access.html" title="class in org.cdlib.mrt.zk">Access</a></li>
<li><a href="org/cdlib/mrt/zk/Access.Queues.html" title="enum in org.cdlib.mrt.zk">Access.Queues</a></li>
<li><a href="org/cdlib/mrt/zk/AccessState.html" title="enum in org.cdlib.mrt.zk">AccessState</a></li>
<li><a href="org/cdlib/mrt/zk/Batch.html" title="class in org.cdlib.mrt.zk">Batch</a></li>
<li><a href="org/cdlib/mrt/zk/BatchState.html" title="enum in org.cdlib.mrt.zk">BatchState</a></li>
Expand All @@ -34,6 +35,8 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/cdlib/mrt/zk/MerrittStateError.html" title="class in org.cdlib.mrt.zk">MerrittStateError</a></li>
<li><a href="org/cdlib/mrt/zk/MerrittZKNodeInvalid.html" title="class in org.cdlib.mrt.zk">MerrittZKNodeInvalid</a></li>
<li><a href="org/cdlib/mrt/zk/QueueItem.html" title="class in org.cdlib.mrt.zk">QueueItem</a></li>
<li><a href="org/cdlib/mrt/zk/QueueItem.ZkPaths.html" title="enum in org.cdlib.mrt.zk">QueueItem.ZkPaths</a></li>
<li><a href="org/cdlib/mrt/zk/QueueItem.ZkPrefixes.html" title="enum in org.cdlib.mrt.zk">QueueItem.ZkPrefixes</a></li>
<li><a href="org/cdlib/mrt/zk/QueueItemHelper.html" title="class in org.cdlib.mrt.zk">QueueItemHelper</a></li>
<li><a href="org/cdlib/mrt/zk/ZKKey.html" title="enum in org.cdlib.mrt.zk">ZKKey</a></li>
</ul>
Expand Down
78 changes: 0 additions & 78 deletions api/java/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,84 +109,6 @@ <h2 title="org.cdlib">org.cdlib.*</h2>
<ul class="blockList">
<li class="blockList">
<table class="constantsSummary">
<caption><span>org.cdlib.mrt.zk.<a href="org/cdlib/mrt/zk/Access.html" title="class in org.cdlib.mrt.zk">Access</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Access.DIR">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Access.html#DIR">DIR</a></code></th>
<td class="colLast"><code>"/access"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Access.PREFIX">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Access.html#PREFIX">PREFIX</a></code></th>
<td class="colLast"><code>"qid"</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary">
<caption><span>org.cdlib.mrt.zk.<a href="org/cdlib/mrt/zk/Batch.html" title="class in org.cdlib.mrt.zk">Batch</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Batch.DIR">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Batch.html#DIR">DIR</a></code></th>
<td class="colLast"><code>"/batches"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Batch.PREFIX">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Batch.html#PREFIX">PREFIX</a></code></th>
<td class="colLast"><code>"bid"</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary">
<caption><span>org.cdlib.mrt.zk.<a href="org/cdlib/mrt/zk/Job.html" title="class in org.cdlib.mrt.zk">Job</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Job.DIR">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Job.html#DIR">DIR</a></code></th>
<td class="colLast"><code>"/jobs"</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a id="org.cdlib.mrt.zk.Job.PREFIX">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><a href="org/cdlib/mrt/zk/Job.html#PREFIX">PREFIX</a></code></th>
<td class="colLast"><code>"jid"</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary">
<caption><span>org.cdlib.mrt.zk.<a href="org/cdlib/mrt/zk/MerrittLocks.html" title="class in org.cdlib.mrt.zk">MerrittLocks</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
Expand Down
Loading

0 comments on commit 9334c33

Please sign in to comment.