Skip to content

Commit

Permalink
Javadoc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
@JuicyDragon
JuicyDragon committed Aug 28, 2019
1 parent df429f3 commit 83f9345
Show file tree
Hide file tree
Showing 18 changed files with 704 additions and 10 deletions.
9 changes: 7 additions & 2 deletions Java/src/main/java/com/nuix/superutilities/misc/ProfileDigester.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
import nuix.ItemEventCallback;
import nuix.ItemEventInfo;

/***
* 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.
* @author Jason Wells
*
*/
public class ProfileDigester {
private static Logger logger = Logger.getLogger(ProfileDigester.class);

Expand Down Expand Up @@ -70,7 +75,7 @@ public void whenMessageLogged(Consumer<String> callback) {
/***
* Invoked when an error occurs in {@link #addItemsToItemSet(Case, String, String, Collection)}. Provides a message String and the item being processed when
* the error occurred. If callback is not provided, message will instead be sent to Nuix log.
* @param callback
* @param callback Callback invoked when an error occurs. If a callback is not provided, message is instead sent to Nuix log as an error.
*/
public void whenErrorLogged(BiConsumer<String,Item> callback) {
errorCallback = callback;
Expand All @@ -88,7 +93,7 @@ public ProfileDigester() {}
* @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
* 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
* and same setting for includeItemText, otherwise deduplication results are undefined.
* @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>.
* @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>.
* @param items The items to add to the item set.
* @return The item set the items were added to.
*/
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/export/PdfWorkCache.html" title="class in com.nuix.superutilities.export" target="classFrame">PdfWorkCache</a></li>
<li><a href="com/nuix/superutilities/misc/PlaceholderResolver.html" title="class in com.nuix.superutilities.misc" target="classFrame">PlaceholderResolver</a></li>
<li><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations" target="classFrame">ProductionSetEvent</a></li>
<li><a href="com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc" target="classFrame">ProfileDigester</a></li>
<li><a href="com/nuix/superutilities/query/QueryHelper.html" title="class in com.nuix.superutilities.query" target="classFrame">QueryHelper</a></li>
<li><a href="com/nuix/superutilities/regex/RegexMatch.html" title="class in com.nuix.superutilities.regex" target="classFrame">RegexMatch</a></li>
<li><a href="com/nuix/superutilities/regex/RegexScanError.html" title="class in com.nuix.superutilities.regex" target="classFrame">RegexScanError</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/export/PdfWorkCache.html" title="class in com.nuix.superutilities.export">PdfWorkCache</a></li>
<li><a href="com/nuix/superutilities/misc/PlaceholderResolver.html" title="class in com.nuix.superutilities.misc">PlaceholderResolver</a></li>
<li><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations">ProductionSetEvent</a></li>
<li><a href="com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc">ProfileDigester</a></li>
<li><a href="com/nuix/superutilities/query/QueryHelper.html" title="class in com.nuix.superutilities.query">QueryHelper</a></li>
<li><a href="com/nuix/superutilities/regex/RegexMatch.html" title="class in com.nuix.superutilities.regex">RegexMatch</a></li>
<li><a href="com/nuix/superutilities/regex/RegexScanError.html" title="class in com.nuix.superutilities.regex">RegexScanError</a></li>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/nuix/superutilities/misc/FormatUtility.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h3>Method Summary</h3>
<td class="colFirst"><code>java.lang.String</code></td>
<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>
<div class="block">Attempts to convert data types, which may be values of metadata properties
or custom meta data, to a String.</div>
or custom metadata, to a String.</div>
</td>
</tr>
<tr id="i6" class="altColor">
Expand Down Expand Up @@ -345,7 +345,7 @@ <h4>bytesToHex</h4>
<h4>convertToString</h4>
<pre>public&nbsp;java.lang.String&nbsp;convertToString(java.lang.Object&nbsp;value)</pre>
<div class="block">Attempts to convert data types, which may be values of metadata properties
or custom meta data, to a String. Data types supported:
or custom metadata, to a String. Data types supported:
- String
- Integer
- Long Integer
Expand Down
4 changes: 2 additions & 2 deletions docs/com/nuix/superutilities/misc/PlaceholderResolver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
<div class="subNav">
<ul class="navList">
<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>
<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>
<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>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/nuix/superutilities/misc/PlaceholderResolver.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -494,7 +494,7 @@ <h4>cleanPathString</h4>
<div class="subNav">
<ul class="navList">
<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>
<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>
<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>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/nuix/superutilities/misc/PlaceholderResolver.html" target="_top">Frames</a></li>
Expand Down
Loading

0 comments on commit 83f9345

Please sign in to comment.