Skip to content

Commit

Permalink
Javadoc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
JuicyDragon committed Aug 30, 2019
1 parent 377faf1 commit b354a37
Show file tree
Hide file tree
Showing 19 changed files with 1,227 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ public static void eachDigest(File sourceDigestList, Consumer<String> md5StringC
* Returns a count of digests present in the given Nuix binary digest list file. This is really just a convenience
* for the calculation:<br><br>
* DIGEST_COUNT = (FILE_SIZE_BYTES - 13) / 16
* @param sourceDigestList
* @param sourceDigestList The digest list file to calculate the digest count of.
* @return The number of digest lists present in the given file based on file size in bytes.
*/
public static int getDigestCount(File sourceDigestList) {
Expand Down Expand Up @@ -181,6 +181,7 @@ public int importFile(File digestListFile) throws Exception {
/***
* Saves a new digest list to a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
* If digest list file already exists, it will be overwritten.
* @param nuixCase The case to save the digest relative to.
* @param name The name of the digest list to save.
* @throws Exception Thrown if there is an error while saving.
*/
Expand Down Expand Up @@ -220,6 +221,7 @@ public void saveSystemLevelDigestList(String name) throws Exception {

/***
* Imports digests from a file located at "[CASE_DIRECTORY]\Stores\User Data\Digest Lists\[NAME].hash" (case level digest list location).
* @param nuixCase The Nuix case the digest list is relative to.
* @param name The name of the digest list to import.
* @return How many digests were imported from the given input Nuix binary digest list file
* that were not already present in this instance.
Expand Down Expand Up @@ -341,7 +343,7 @@ public void addMd5(byte[] md5Bytes) {

/***
* Removes the given MD5 from this instance.
* @param md5s MD5 string to remove.
* @param md5 MD5 string to remove.
*/
public void removeMd5(String md5) {
byte[] md5Bytes = FormatUtility.hexToBytes(md5);
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFile.html" title="class in com.nuix.superutilities.loadfiles" target="classFrame">DatLoadFile</a></li>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFileReader.html" title="class in com.nuix.superutilities.loadfiles" target="classFrame">DatLoadFileReader</a></li>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFileWriter.html" title="class in com.nuix.superutilities.loadfiles" target="classFrame">DatLoadFileWriter</a></li>
<li><a href="com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc" target="classFrame">DigestList</a></li>
<li><a href="com/nuix/superutilities/misc/DriveSpaceInfo.html" title="class in com.nuix.superutilities.misc" target="classFrame">DriveSpaceInfo</a></li>
<li><a href="com/nuix/superutilities/annotations/ExclusionEvent.html" title="class in com.nuix.superutilities.annotations" target="classFrame">ExclusionEvent</a></li>
<li><a href="com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc" target="classFrame">ExpandedTermInfo</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFile.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFile</a></li>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFileReader.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFileReader</a></li>
<li><a href="com/nuix/superutilities/loadfiles/DatLoadFileWriter.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFileWriter</a></li>
<li><a href="com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></li>
<li><a href="com/nuix/superutilities/misc/DriveSpaceInfo.html" title="class in com.nuix.superutilities.misc">DriveSpaceInfo</a></li>
<li><a href="com/nuix/superutilities/annotations/ExclusionEvent.html" title="class in com.nuix.superutilities.annotations">ExclusionEvent</a></li>
<li><a href="com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc">ExpandedTermInfo</a></li>
Expand Down
953 changes: 953 additions & 0 deletions docs/com/nuix/superutilities/misc/DigestList.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/com/nuix/superutilities/misc/DriveSpaceInfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down Expand Up @@ -371,7 +371,7 @@ <h4>toString</h4>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down
123 changes: 123 additions & 0 deletions docs/com/nuix/superutilities/misc/class-use/DigestList.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Class com.nuix.superutilities.misc.DigestList</title>
<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="Uses of Class com.nuix.superutilities.misc.DigestList";
}
}
catch(err) {
}
//-->
</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><a href="../../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/nuix/superutilities/misc/class-use/DigestList.html" target="_top">Frames</a></li>
<li><a href="DigestList.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class com.nuix.superutilities.misc.DigestList" class="title">Uses of Class<br>com.nuix.superutilities.misc.DigestList</h2>
</div>
<div class="classUseContainer">No usage of com.nuix.superutilities.misc.DigestList</div>
<!-- ======= 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><a href="../../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">Class</a></li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/nuix/superutilities/misc/class-use/DigestList.html" target="_top">Frames</a></li>
<li><a href="DigestList.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
1 change: 1 addition & 0 deletions docs/com/nuix/superutilities/misc/package-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ <h2 title="Interfaces">Interfaces</h2>
</ul>
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="DigestList.html" title="class in com.nuix.superutilities.misc" target="classFrame">DigestList</a></li>
<li><a href="DriveSpaceInfo.html" title="class in com.nuix.superutilities.misc" target="classFrame">DriveSpaceInfo</a></li>
<li><a href="ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc" target="classFrame">ExpandedTermInfo</a></li>
<li><a href="FormatUtility.html" title="class in com.nuix.superutilities.misc" target="classFrame">FormatUtility</a></li>
Expand Down
30 changes: 18 additions & 12 deletions docs/com/nuix/superutilities/misc/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,77 +99,83 @@ <h1 title="Package" class="title">Package&nbsp;com.nuix.superutilities.misc</h1>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></td>
<td class="colLast">
<div class="block">This class provides an in-memory representation of a Nuix binary digest list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/DriveSpaceInfo.html" title="class in com.nuix.superutilities.misc">DriveSpaceInfo</a></td>
<td class="colLast">
<div class="block">Encapsulates drive space information to callback responding to events fired
by <a href="../../../../com/nuix/superutilities/misc/FreeSpaceMonitor.html" title="class in com.nuix.superutilities.misc"><code>FreeSpaceMonitor</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc">ExpandedTermInfo</a></td>
<td class="colLast">
<div class="block">Encapsulates information about a term designated as a match result generated by <a href="../../../../com/nuix/superutilities/misc/TermExpander.html" title="class in com.nuix.superutilities.misc"><code>TermExpander</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html" title="class in com.nuix.superutilities.misc">FormatUtility</a></td>
<td class="colLast">
<div class="block">Class which offers methods for formatting values.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/FreeSpaceMonitor.html" title="class in com.nuix.superutilities.misc">FreeSpaceMonitor</a></td>
<td class="colLast">
<div class="block">Provides a way to monitor file system locations and act when available disk space drops
below a specified threshold.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/FuzzyTermInfo.html" title="class in com.nuix.superutilities.misc">FuzzyTermInfo</a></td>
<td class="colLast">
<div class="block">Encapsulates information about a fuzzy term expression.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/LevenshteinDistance.html" title="class in com.nuix.superutilities.misc">LevenshteinDistance</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/NamedStringList.html" title="class in com.nuix.superutilities.misc">NamedStringList</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/NuixVersion.html" title="class in com.nuix.superutilities.misc">NuixVersion</a></td>
<td class="colLast">
<div class="block">Assists in representing a Nuix version in object form to assist with comparing two versions.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/PdfUtility.html" title="class in com.nuix.superutilities.misc">PdfUtility</a></td>
<td class="colLast">
<div class="block">A class containing some helper methods for PDFs.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/PlaceholderResolver.html" title="class in com.nuix.superutilities.misc">PlaceholderResolver</a></td>
<td class="colLast">
<div class="block">This class provides a way to allow user input to make use of place holder values which will be
substituted at run time with appropriate values.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc">ProfileDigester</a></td>
<td class="colLast">
<div class="block">Provides functionality related to generating an MD5 digest for an item based on a concatenation of the values yielded by a MetadataProfile for a given item.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/SQLiteBacked.html" title="class in com.nuix.superutilities.misc">SQLiteBacked</a></td>
<td class="colLast">
<div class="block">Provides a wrapper around a SQLite database.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/nuix/superutilities/misc/TermExpander.html" title="class in com.nuix.superutilities.misc">TermExpander</a></td>
<td class="colLast">&nbsp;</td>
</tr>
Expand Down
1 change: 1 addition & 0 deletions docs/com/nuix/superutilities/misc/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li type="circle">java.lang.Object
<ul>
<li type="circle">com.nuix.superutilities.misc.<a href="../../../../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">DigestList</span></a> (implements java.lang.Iterable&lt;T&gt;)</li>
<li type="circle">com.nuix.superutilities.misc.<a href="../../../../com/nuix/superutilities/misc/DriveSpaceInfo.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">DriveSpaceInfo</span></a></li>
<li type="circle">com.nuix.superutilities.misc.<a href="../../../../com/nuix/superutilities/misc/ExpandedTermInfo.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">ExpandedTermInfo</span></a></li>
<li type="circle">com.nuix.superutilities.misc.<a href="../../../../com/nuix/superutilities/misc/FormatUtility.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">FormatUtility</span></a></li>
Expand Down
16 changes: 16 additions & 0 deletions docs/index-files/index-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,14 @@ <h2 class="title">A</h2>
<dd>
<div class="block">Adds a regular expression to the list of expressions used to locate text to markup.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/DigestList.html#addItem-nuix.Item-">addItem(Item)</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></dt>
<dd>
<div class="block">Adds the MD5 of the provided item to this instance (if not already present).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/DigestList.html#addItems-java.util.Collection-">addItems(Collection&lt;Item&gt;)</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></dt>
<dd>
<div class="block">Adds the MD5s of the provided items to this instance (if not already present).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/ProfileDigester.html#addItemsToItemSet-nuix.Case-java.lang.String-java.lang.String-java.util.Collection-">addItemsToItemSet(Case, String, String, Collection&lt;Item&gt;)</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc">ProfileDigester</a></dt>
<dd>
<div class="block">Adds items to an item set using "Scripted" deduplication, providing a MD5 hash generated from the concatenation of the values yielded
Expand All @@ -144,6 +152,14 @@ <h2 class="title">A</h2>
<dd>
<div class="block">Adds a match to this instance.</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/DigestList.html#addMd5-java.lang.String-">addMd5(String)</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></dt>
<dd>
<div class="block">Adds the given MD5 to this instance (if not already present).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/DigestList.html#addMd5-byte:A-">addMd5(byte[])</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/DigestList.html" title="class in com.nuix.superutilities.misc">DigestList</a></dt>
<dd>
<div class="block">Adds the given MD5 to this instance (if not already present).</div>
</dd>
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/FreeSpaceMonitor.html#addMonitoredLocation-java.lang.String-double-">addMonitoredLocation(String, double)</a></span> - Method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/FreeSpaceMonitor.html" title="class in com.nuix.superutilities.misc">FreeSpaceMonitor</a></dt>
<dd>
<div class="block">Adds a location to be monitored</div>
Expand Down
Loading

0 comments on commit b354a37

Please sign in to comment.