Skip to content

Commit

Permalink
javadoc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
@JuicyDragon
JuicyDragon committed Sep 10, 2024
1 parent 88c5045 commit 221b222
Show file tree
Hide file tree
Showing 17 changed files with 1,481 additions and 103 deletions.
2 changes: 2 additions & 0 deletions Java/SuperUtilities/src/main/java/com/nuix/superutilities/misc/PlaceholderResolver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ public void setFromItem(Item item) {
* <code>{date_month}</code> - The datetime of invocation, as 2 digit month<br>
* <code>{date_day}</code> - The datetime of invocation, as 2 digit day of the month<br>
* <code>{nuix_version}</code> - The Nuix version as defined in <code>NUIX_VERSION</code><br>
* @param now DateTime instance to use for all placeholders, likely you would want to provide a moment in time
* such as when an export started.
*/
public void setStandardValues(DateTime now) {
if (now == null) {
Expand Down
163 changes: 92 additions & 71 deletions docs/allclasses-index.html
View file

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/allclasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/annotations/AnnotationSyncSettings.html" title="class in com.nuix.superutilities.annotations">AnnotationSyncSettings</a></li>
<li><a href="com/nuix/superutilities/reporting/AsposeCellsColorHelper.html" title="class in com.nuix.superutilities.reporting">AsposeCellsColorHelper</a></li>
<li><a href="com/nuix/superutilities/reporting/AsposeCellsStyleHelper.html" title="class in com.nuix.superutilities.reporting">AsposeCellsStyleHelper</a></li>
<li><a href="com/nuix/superutilities/misc/BoundedProgressInfo.html" title="class in com.nuix.superutilities.misc">BoundedProgressInfo</a></li>
<li><a href="com/nuix/superutilities/cases/BulkCaseProcessor.html" title="class in com.nuix.superutilities.cases">BulkCaseProcessor</a></li>
<li><a href="com/nuix/superutilities/annotations/BulkRedactor.html" title="class in com.nuix.superutilities.annotations">BulkRedactor</a></li>
<li><a href="com/nuix/superutilities/annotations/BulkRedactorProgressInfo.html" title="class in com.nuix.superutilities.annotations">BulkRedactorProgressInfo</a></li>
Expand Down Expand Up @@ -79,10 +80,12 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/nuix/superutilities/regex/PatternInfo.html" title="class in com.nuix.superutilities.regex">PatternInfo</a></li>
<li><a href="com/nuix/superutilities/misc/PdfUtility.html" title="class in com.nuix.superutilities.misc">PdfUtility</a></li>
<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/PeriodicGatedConsumer.html" title="class in com.nuix.superutilities.misc">PeriodicGatedConsumer</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/misc/PrimitiveTypeParser.html" title="class in com.nuix.superutilities.misc">PrimitiveTypeParser</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/misc/ProgressInfo.html" title="class in com.nuix.superutilities.misc">ProgressInfo</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
76 changes: 65 additions & 11 deletions docs/com/nuix/superutilities/export/CustomExporter.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":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -213,7 +213,9 @@ <h3>Method Summary</h3>
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#exportJson(java.lang.String,com.nuix.superutilities.export.JsonExporter)">exportJson</a></span>&#8203;(java.lang.String&nbsp;fileNameTemplate,
<a href="JsonExporter.html" title="class in com.nuix.superutilities.export">JsonExporter</a>&nbsp;jsonExporter)</code></th>
<td class="colLast">&nbsp;</td>
<td class="colLast">
<div class="block">Enables export of JSON files using the provided settings.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
Expand Down Expand Up @@ -299,6 +301,19 @@ <h3>Method Summary</h3>
the temporary export before restructuring.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#whenMessageLogged(java.util.function.Consumer)">whenMessageLogged</a></span>&#8203;(java.util.function.Consumer&lt;java.lang.String&gt;&nbsp;messageLoggedCallback)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#whenProgressEventOccurs(java.util.function.Consumer)">whenProgressEventOccurs</a></span>&#8203;(java.util.function.Consumer&lt;<a href="../misc/BoundedProgressInfo.html" title="class in com.nuix.superutilities.misc">BoundedProgressInfo</a>&gt;&nbsp;progressCallback)</code></th>
<td class="colLast">
<div class="block">Provides a callback to be invoked when progress is made during initial batch export or during
restructuring phase.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
Expand Down Expand Up @@ -342,6 +357,31 @@ <h4>CustomExporter</h4>
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="whenProgressEventOccurs(java.util.function.Consumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>whenProgressEventOccurs</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;whenProgressEventOccurs&#8203;(java.util.function.Consumer&lt;<a href="../misc/BoundedProgressInfo.html" title="class in com.nuix.superutilities.misc">BoundedProgressInfo</a>&gt;&nbsp;progressCallback)</pre>
<div class="block">Provides a callback to be invoked when progress is made during initial batch export or during
restructuring phase. Will be wrapped in a <a href="../misc/PeriodicGatedConsumer.html" title="class in com.nuix.superutilities.misc"><code>PeriodicGatedConsumer</code></a> with an interval of 5 seconds
if not already an instance of <a href="../misc/PeriodicGatedConsumer.html" title="class in com.nuix.superutilities.misc"><code>PeriodicGatedConsumer</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>progressCallback</code> - The progress info consumer.</dd>
</dl>
</li>
</ul>
<a id="whenMessageLogged(java.util.function.Consumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>whenMessageLogged</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;whenMessageLogged&#8203;(java.util.function.Consumer&lt;java.lang.String&gt;&nbsp;messageLoggedCallback)</pre>
</li>
</ul>
<a id="setDynamicPlaceholder(java.lang.String,java.util.function.BiFunction)">
<!-- -->
</a>
Expand All @@ -353,10 +393,11 @@ <h4>setDynamicPlaceholder</h4>
<div class="block">Assigns a dynamically calculated placeholder to this instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>placeholderName</code> - Placeholder name with "{" or "}". For example "my_value". Placeholder in templates can then be referred to using "{my_value}". It is
preferred that you use only lower case characters and no whitespace characters. Letters, numbers and underscores only is recommended.</dd>
<dd><code>function</code> - A function which accepts as arguments an item and String with product type. Expected to return a String value. If function yields a null
then placeholder will resolve to "NO_VALUE" when resolving the template.</dd>
<dd><code>placeholderName</code> - Placeholder name with "{" or "}". For example "my_value". Placeholder in templates can
then be referred to using "{my_value}". It is preferred that you use only lower case
characters and no whitespace characters. Letters, numbers and underscores only is recommended.</dd>
<dd><code>function</code> - A function which accepts as arguments an item and String with product type. Expected to return a
String value. If function yields a null then placeholder will resolve to "NO_VALUE" when resolving the template.</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -396,7 +437,8 @@ <h4>exportNatives</h4>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.</dd>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
<dd><code>emailExportSettings</code> - Email native export settings as supported by <b>BatchExporter</b></dd>
</dl>
</li>
Expand All @@ -413,7 +455,8 @@ <h4>exportText</h4>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.</dd>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
<dd><code>textExportSettings</code> - Text file export settings as supported by <b>BatchExporter</b></dd>
</dl>
</li>
Expand All @@ -430,7 +473,8 @@ <h4>exportPdfs</h4>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.</dd>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
<dd><code>pdfExportSettings</code> - PDF export settings as supported by <b>BatchExporter</b></dd>
</dl>
</li>
Expand All @@ -447,7 +491,8 @@ <h4>exportTiffs</h4>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.</dd>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
<dd><code>tiffExportSettings</code> - TIFF export settings as supported by <b>BatchExporter</b></dd>
</dl>
</li>
Expand All @@ -463,7 +508,8 @@ <h4>exportJson</h4>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.</dd>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
</dl>
</li>
</ul>
Expand All @@ -475,6 +521,14 @@ <h4>exportJson</h4>
<h4>exportJson</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;exportJson&#8203;(java.lang.String&nbsp;fileNameTemplate,
<a href="JsonExporter.html" title="class in com.nuix.superutilities.export">JsonExporter</a>&nbsp;jsonExporter)</pre>
<div class="block">Enables export of JSON files using the provided settings. See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a>
to see what placeholders are inherently supported by <b>fileNameTemplate</b></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNameTemplate</code> - A filename template that dictates the ultimate export structure.
See <a href="../misc/PlaceholderResolver.html#setFromItem(nuix.Item)"><code>PlaceholderResolver.setFromItem(Item)</code></a> for a baseline set of built-in per-item placeholders.</dd>
<dd><code>jsonExporter</code> - A <a href="JsonExporter.html" title="class in com.nuix.superutilities.export"><code>JsonExporter</code></a> instance in case you wish to customize serialization.</dd>
</dl>
</li>
</ul>
<a id="setColumnRemovals(java.util.Collection)">
Expand Down
Loading

0 comments on commit 221b222

Please sign in to comment.