Skip to content

Commit

Permalink
updated javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@JuicyDragon
JuicyDragon committed Oct 28, 2024
1 parent e093ebb commit 9b310e7
Show file tree
Hide file tree
Showing 11 changed files with 179 additions and 36 deletions.
2 changes: 1 addition & 1 deletion docs/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/BoundedProgressInfo.html" title="class in com.nuix.superutilities.misc">BoundedProgressInfo</a></td>
<th class="colLast" scope="row">
<div class="block">Represents progress of an operation which has a bounded value, that is, we known what progress
<div class="block">Represents progress of an operation which has a bounded value, that is, we know what progress
value is considered maximum/done.</div>
</th>
</tr>
Expand Down
102 changes: 90 additions & 12 deletions docs/com/nuix/superutilities/items/SuperItemUtility.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -188,49 +188,73 @@ <h3>Method Summary</h3>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>nuix.Item</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findAncestor(nuix.Item,java.util.function.Predicate)">findAncestor</a></span>&#8203;(@NotNull nuix.Item&nbsp;item,
@NotNull java.util.function.Predicate&lt;nuix.Item&gt;&nbsp;ancestorPredicate)</code></th>
<td class="colLast">
<div class="block">Traverses an item's ancestors bottom up, until the first item for which the predicate yields true
or null if no ancestor matches the predicate.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>nuix.Item</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findContainerAncestor(nuix.Item)">findContainerAncestor</a></span>&#8203;(nuix.Item&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Traverses up an item's path to locate the nearest ancestor container item (kind:container) or
null if there is no container ancestor item.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findContainerAncestors(java.util.Collection)">findContainerAncestors</a></span>&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Similar to <a href="#findContainerAncestor(nuix.Item)"><code>findContainerAncestor(Item)</code></a>, but resolves nearest container ancestor items
for multiple items at once.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findFamiliesWithoutItemsResponsiveToQuery(nuix.Case,java.util.Collection,java.lang.String)">findFamiliesWithoutItemsResponsiveToQuery</a></span>&#8203;(nuix.Case&nbsp;nuixCase,
java.util.Collection&lt;nuix.Item&gt;&nbsp;inputItems,
java.lang.String&nbsp;itemsToRemoveQuery)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findItemsAndParents(java.util.Collection)">findItemsAndParents</a></span>&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Resolves input collection of items to a set which includes both parents of
input items and the input items themselves.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findParents(java.util.Collection)">findParents</a></span>&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Resolves input collection of items to parent items.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>nuix.Item</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findPhysicalFileAncestor(nuix.Item)">findPhysicalFileAncestor</a></span>&#8203;(nuix.Item&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Traverses up an item's path to locate the ancestor physical file item (flag:physical_file) or
null if there is no physical file ancestor item.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findPhysicalFileAncestors(java.util.Collection)">findPhysicalFileAncestors</a></span>&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</code></th>
<td class="colLast">
<div class="block">Similar to <a href="#findPhysicalFileAncestor(nuix.Item)"><code>findPhysicalFileAncestor(Item)</code></a>, but resolves physical file ancestor items
for multiple items at once.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="SuperItemUtility.html" title="class in com.nuix.superutilities.items">SuperItemUtility</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.List&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getItemsAndNeighboringSiblings(java.util.List,int,int)">getItemsAndNeighboringSiblings</a></span>&#8203;(java.util.List&lt;nuix.Item&gt;&nbsp;items,
int&nbsp;itemsBefore,
Expand All @@ -239,22 +263,22 @@ <h3>Method Summary</h3>
<div class="block">Gets items and sibling items within a certain ordinal distance.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPhysicalAncestorPath(nuix.Item)">getPhysicalAncestorPath</a></span>&#8203;(nuix.Item&nbsp;item)</code></th>
<td class="colLast">
<div class="block">Returns the file system path of an item's physical file ancestor.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#itemsAreSiblings(nuix.Item,nuix.Item)">itemsAreSiblings</a></span>&#8203;(nuix.Item&nbsp;a,
nuix.Item&nbsp;b)</code></th>
<td class="colLast">
<div class="block">Tests whether 2 items have the same parent by comparing their tree position values</div>
</td>
</tr>
<tr id="i10" class="altColor">
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeItemsResponsiveToQuery(nuix.Case,java.util.Collection,java.lang.String)">removeItemsResponsiveToQuery</a></span>&#8203;(nuix.Case&nbsp;nuixCase,
java.util.Collection&lt;nuix.Item&gt;&nbsp;inputItems,
Expand All @@ -263,7 +287,7 @@ <h3>Method Summary</h3>
<div class="block">Convenience method for removing items responsive to a query from another collection of items.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#splitAndMaintainFamilies(java.util.Collection,int,java.util.function.Consumer)">splitAndMaintainFamilies</a></span>&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items,
int&nbsp;targetChunkSize,
Expand All @@ -272,7 +296,7 @@ <h3>Method Summary</h3>
<div class="block">Splits a collection of items into a target chunk size, while maintaining families.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;nuix.Item&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unionMany(java.util.List)">unionMany</a></span>&#8203;(java.util.List&lt;java.util.Collection&lt;nuix.Item&gt;&gt;&nbsp;itemCollections)</code></th>
<td class="colLast">
Expand Down Expand Up @@ -364,6 +388,27 @@ <h4>findPhysicalFileAncestor</h4>
</dl>
</li>
</ul>
<a id="findAncestor(nuix.Item,java.util.function.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findAncestor</h4>
<pre class="methodSignature">public&nbsp;nuix.Item&nbsp;findAncestor&#8203;(@NotNull
@NotNull nuix.Item&nbsp;item,
@NotNull
@NotNull java.util.function.Predicate&lt;nuix.Item&gt;&nbsp;ancestorPredicate)</pre>
<div class="block">Traverses an item's ancestors bottom up, until the first item for which the predicate yields true
or null if no ancestor matches the predicate.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>item</code> - The item whose ancestors will be inspected</dd>
<dd><code>ancestorPredicate</code> - A predicate for matching the target ancestor</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The first ancestor matched walking bottom up or null if none matched the predicate</dd>
</dl>
</li>
</ul>
<a id="findPhysicalFileAncestors(java.util.Collection)">
<!-- -->
</a>
Expand Down Expand Up @@ -415,6 +460,39 @@ <h4>findContainerAncestors</h4>
</dl>
</li>
</ul>
<a id="findParents(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findParents</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;nuix.Item&gt;&nbsp;findParents&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</pre>
<div class="block">Resolves input collection of items to parent items.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - The items to resolve to parent items</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The parent items of the provide input items</dd>
</dl>
</li>
</ul>
<a id="findItemsAndParents(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findItemsAndParents</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;nuix.Item&gt;&nbsp;findItemsAndParents&#8203;(java.util.Collection&lt;nuix.Item&gt;&nbsp;items)</pre>
<div class="block">Resolves input collection of items to a set which includes both parents of
input items and the input items themselves.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - The items to resolve the parents of</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The input items and their parent items</dd>
</dl>
</li>
</ul>
<a id="splitAndMaintainFamilies(java.util.Collection,int,java.util.function.Consumer)">
<!-- -->
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/nuix/superutilities/misc/BoundedProgressInfo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2 title="Class BoundedProgressInfo" class="title">Class BoundedProgressInfo</h
<hr>
<pre>public class <span class="typeNameLabel">BoundedProgressInfo</span>
extends <a href="ProgressInfo.html" title="class in com.nuix.superutilities.misc">ProgressInfo</a></pre>
<div class="block">Represents progress of an operation which has a bounded value, that is, we known what progress
<div class="block">Represents progress of an operation which has a bounded value, that is, we know what progress
value is considered maximum/done.</div>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/com/nuix/superutilities/misc/PeriodicGatedConsumer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h2 title="Class PeriodicGatedConsumer" class="title">Class PeriodicGatedConsume
extends java.lang.Object
implements java.util.function.Consumer&lt;T&gt;</pre>
<div class="block">A wrapper for a <code>Consumer</code> instance which will only periodically forward call to <code>accept</code>
method of wrapped instance. Created for taking per item events that Nuix publishes and turning them
method of wrapped instance. Created for taking frequent events that are published and turning them
into periodic progress reporters.</div>
</li>
</ul>
Expand Down
Loading

0 comments on commit 9b310e7

Please sign in to comment.