Skip to content

Commit 83f9345

Browse files
JuicyDragonJuicyDragon
committed
Javadoc refresh
1 parent df429f3 commit 83f9345

18 files changed

+704
-10
lines changed

‎Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@
1919
import nuix.ItemEventCallback;
2020
import nuix.ItemEventInfo;
2121

22+
/***
23+
* 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.
24+
* @author Jason Wells
25+
*
26+
*/
2227
public class ProfileDigester {
2328
private static Logger logger = Logger.getLogger(ProfileDigester.class);
2429

@@ -70,7 +75,7 @@ public void whenMessageLogged(Consumer<String> callback) {
7075
/***
7176
* Invoked when an error occurs in {@link #addItemsToItemSet(Case, String, String, Collection)}. Provides a message String and the item being processed when
7277
* the error occurred. If callback is not provided, message will instead be sent to Nuix log.
73-
* @param callback
78+
* @param callback Callback invoked when an error occurs. If a callback is not provided, message is instead sent to Nuix log as an error.
7479
*/
7580
public void whenErrorLogged(BiConsumer<String,Item> callback) {
7681
errorCallback = callback;
@@ -88,7 +93,7 @@ public ProfileDigester() {}
8893
* @param itemSetName Name of item set. If item set already exists, existing item set will be used, if not one will be created. <b>Important:</b> when
8994
* adding items to an existing item set, it is important that items previously added to that item set were added using this method, the same metadata profile
9095
* and same setting for includeItemText, otherwise deduplication results are undefined.
91-
* @param deduplicateBy Valid options are "INDIVIDUAL" and "FAMILY", these settings correspond to the behaviors noted in <a href="https://download.nuix.com/releases/desktop/stable/docs/en/scripting/api/nuix/ItemSet.html#addItems-java.util.Collection-java.util.Map-">addItems(Collection<Item> items, Map<?,?> options)</a>.
96+
* @param deduplicateBy Valid options are "INDIVIDUAL" and "FAMILY", these settings correspond to the behaviors noted in <a href="https://download.nuix.com/releases/desktop/stable/docs/en/scripting/api/nuix/ItemSet.html#addItems-java.util.Collection-java.util.Map-">addItems(Collection&lt;Item&gt; items, Map&lt;?,?&gt; options)</a>.
9297
* @param items The items to add to the item set.
9398
* @return The item set the items were added to.
9499
*/

‎docs/allclasses-frame.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
6969
<li><a href="com/nuix/superutilities/export/PdfWorkCache.html" title="class in com.nuix.superutilities.export" target="classFrame">PdfWorkCache</a></li>
7070
<li><a href="com/nuix/superutilities/misc/PlaceholderResolver.html" title="class in com.nuix.superutilities.misc" target="classFrame">PlaceholderResolver</a></li>
7171
<li><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations" target="classFrame">ProductionSetEvent</a></li>
72+
<li><a href="com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc" target="classFrame">ProfileDigester</a></li>
7273
<li><a href="com/nuix/superutilities/query/QueryHelper.html" title="class in com.nuix.superutilities.query" target="classFrame">QueryHelper</a></li>
7374
<li><a href="com/nuix/superutilities/regex/RegexMatch.html" title="class in com.nuix.superutilities.regex" target="classFrame">RegexMatch</a></li>
7475
<li><a href="com/nuix/superutilities/regex/RegexScanError.html" title="class in com.nuix.superutilities.regex" target="classFrame">RegexScanError</a></li>

‎docs/allclasses-noframe.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
6969
<li><a href="com/nuix/superutilities/export/PdfWorkCache.html" title="class in com.nuix.superutilities.export">PdfWorkCache</a></li>
7070
<li><a href="com/nuix/superutilities/misc/PlaceholderResolver.html" title="class in com.nuix.superutilities.misc">PlaceholderResolver</a></li>
7171
<li><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations">ProductionSetEvent</a></li>
72+
<li><a href="com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc">ProfileDigester</a></li>
7273
<li><a href="com/nuix/superutilities/query/QueryHelper.html" title="class in com.nuix.superutilities.query">QueryHelper</a></li>
7374
<li><a href="com/nuix/superutilities/regex/RegexMatch.html" title="class in com.nuix.superutilities.regex">RegexMatch</a></li>
7475
<li><a href="com/nuix/superutilities/regex/RegexScanError.html" title="class in com.nuix.superutilities.regex">RegexScanError</a></li>

‎docs/com/nuix/superutilities/misc/FormatUtility.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ <h3>Method Summary</h3>
175175
<td class="colFirst"><code>java.lang.String</code></td>
176176
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#convertToString-java.lang.Object-">convertToString</a></span>(java.lang.Object&nbsp;value)</code>
177177
<div class="block">Attempts to convert data types, which may be values of metadata properties
178-
or custom meta data, to a String.</div>
178+
or custom metadata, to a String.</div>
179179
</td>
180180
</tr>
181181
<tr id="i6" class="altColor">
@@ -345,7 +345,7 @@ <h4>bytesToHex</h4>
345345
<h4>convertToString</h4>
346346
<pre>public&nbsp;java.lang.String&nbsp;convertToString(java.lang.Object&nbsp;value)</pre>
347347
<div class="block">Attempts to convert data types, which may be values of metadata properties
348-
or custom meta data, to a String. Data types supported:
348+
or custom metadata, to a String. Data types supported:
349349
- String
350350
- Integer
351351
- Long Integer

‎docs/com/nuix/superutilities/misc/PlaceholderResolver.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<div class="subNav">
5050
<ul class="navList">
5151
<li><a href="../../../../com/nuix/superutilities/misc/PdfUtility.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
52-
<li><a href="../../../../com/nuix/superutilities/misc/SimilarityCalculation.html" title="enum in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
52+
<li><a href="../../../../com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
5353
</ul>
5454
<ul class="navList">
5555
<li><a href="../../../../index.html?com/nuix/superutilities/misc/PlaceholderResolver.html" target="_top">Frames</a></li>
@@ -494,7 +494,7 @@ <h4>cleanPathString</h4>
494494
<div class="subNav">
495495
<ul class="navList">
496496
<li><a href="../../../../com/nuix/superutilities/misc/PdfUtility.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
497-
<li><a href="../../../../com/nuix/superutilities/misc/SimilarityCalculation.html" title="enum in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
497+
<li><a href="../../../../com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
498498
</ul>
499499
<ul class="navList">
500500
<li><a href="../../../../index.html?com/nuix/superutilities/misc/PlaceholderResolver.html" target="_top">Frames</a></li>

0 commit comments

Comments
 (0)