Skip to content

Commit

Permalink
javadoc refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
JuicyDragon committed Aug 22, 2024
1 parent 7de986c commit b4607e7
Show file tree
Hide file tree
Showing 16 changed files with 750 additions and 283 deletions.
44 changes: 24 additions & 20 deletions docs/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
catch(err) {
}
//-->
var data = {"i0":2,"i1":2,"i2":2,"i3":4,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":1,"i13":2,"i14":2,"i15":4,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":1,"i36":2,"i37":2,"i38":1,"i39":2,"i40":2,"i41":2,"i42":2,"i43":2,"i44":1,"i45":2,"i46":2,"i47":2,"i48":2,"i49":2,"i50":2,"i51":2,"i52":2,"i53":2,"i54":2,"i55":2,"i56":2,"i57":2,"i58":2,"i59":2,"i60":2,"i61":2,"i62":2,"i63":2,"i64":2,"i65":4,"i66":2,"i67":2,"i68":2,"i69":2,"i70":2,"i71":2,"i72":2,"i73":2,"i74":2,"i75":2,"i76":2,"i77":2};
var data = {"i0":2,"i1":2,"i2":2,"i3":4,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":1,"i13":2,"i14":2,"i15":4,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":1,"i36":2,"i37":2,"i38":1,"i39":2,"i40":2,"i41":2,"i42":2,"i43":2,"i44":1,"i45":2,"i46":2,"i47":2,"i48":2,"i49":2,"i50":2,"i51":2,"i52":2,"i53":2,"i54":2,"i55":2,"i56":2,"i57":2,"i58":2,"i59":2,"i60":2,"i61":2,"i62":2,"i63":2,"i64":2,"i65":2,"i66":4,"i67":2,"i68":2,"i69":2,"i70":2,"i71":2,"i72":2,"i73":2,"i74":2,"i75":2,"i76":2,"i77":2,"i78":2};
var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -427,111 +427,115 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
</th>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations">ProductionSetEvent</a></td>
<td class="colFirst"><a href="com/nuix/superutilities/misc/PrimitiveTypeParser.html" title="class in com.nuix.superutilities.misc">PrimitiveTypeParser</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/annotations/ProductionSetEvent.html" title="class in com.nuix.superutilities.annotations">ProductionSetEvent</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/ProfileDigester.html" title="class in com.nuix.superutilities.misc">ProfileDigester</a></td>
<th class="colLast" scope="row">
<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>
</th>
</tr>
<tr id="i60" class="altColor">
<tr id="i61" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/query/QueryHelper.html" title="class in com.nuix.superutilities.query">QueryHelper</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i61" class="rowColor">
<tr id="i62" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/regex/RegexMatch.html" title="class in com.nuix.superutilities.regex">RegexMatch</a></td>
<th class="colLast" scope="row">
<div class="block">Represents information about a regular expression match.</div>
</th>
</tr>
<tr id="i62" class="altColor">
<tr id="i63" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/regex/RegexScanError.html" title="class in com.nuix.superutilities.regex">RegexScanError</a></td>
<th class="colLast" scope="row">
<div class="block">Represents information about an error which occurred in <a href="com/nuix/superutilities/regex/RegexScanner.html" title="class in com.nuix.superutilities.regex"><code>RegexScanner</code></a> while scanning.</div>
</th>
</tr>
<tr id="i63" class="rowColor">
<tr id="i64" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/regex/RegexScanner.html" title="class in com.nuix.superutilities.regex">RegexScanner</a></td>
<th class="colLast" scope="row">
<div class="block">Class for scanning a series of items with a series of regular expressions.</div>
</th>
</tr>
<tr id="i64" class="altColor">
<tr id="i65" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/reporting/ScriptedColumnValueGenerator.html" title="class in com.nuix.superutilities.reporting">ScriptedColumnValueGenerator</a></td>
<th class="colLast" scope="row">
<div class="block">A <a href="com/nuix/superutilities/reporting/ColumnValueGenerator.html" title="class in com.nuix.superutilities.reporting"><code>ColumnValueGenerator</code></a> which uses the provided BiFunction expression to calculate its value.</div>
</th>
</tr>
<tr id="i65" class="rowColor">
<tr id="i66" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/SimilarityCalculation.html" title="enum in com.nuix.superutilities.misc">SimilarityCalculation</a></td>
<th class="colLast" scope="row">
<div class="block">Used by <a href="com/nuix/superutilities/misc/TermExpander.html" title="class in com.nuix.superutilities.misc"><code>TermExpander</code></a> to determine how fuzzy similarity should be
calculated to expand a given fuzzy term into matched terms.</div>
</th>
</tr>
<tr id="i66" class="altColor">
<tr id="i67" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/loadfiles/SimpleTextFileReader.html" title="class in com.nuix.superutilities.loadfiles">SimpleTextFileReader</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i67" class="rowColor">
<tr id="i68" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/loadfiles/SimpleTextFileWriter.html" title="class in com.nuix.superutilities.loadfiles">SimpleTextFileWriter</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i68" class="altColor">
<tr id="i69" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/reporting/SimpleWorksheet.html" title="class in com.nuix.superutilities.reporting">SimpleWorksheet</a></td>
<th class="colLast" scope="row">
<div class="block">Wrapper class around Aspose Cells Worksheet object which simplifies some of the
more common operations.</div>
</th>
</tr>
<tr id="i69" class="rowColor">
<tr id="i70" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/reporting/SimpleXlsx.html" title="class in com.nuix.superutilities.reporting">SimpleXlsx</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i70" class="altColor">
<tr id="i71" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/SQLiteBacked.html" title="class in com.nuix.superutilities.misc">SQLiteBacked</a></td>
<th class="colLast" scope="row">
<div class="block">Provides a wrapper around a SQLite database.</div>
</th>
</tr>
<tr id="i71" class="rowColor">
<tr id="i72" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/items/SuperItemUtility.html" title="class in com.nuix.superutilities.items">SuperItemUtility</a></td>
<th class="colLast" scope="row">
<div class="block">Offers methods for working with items and item collections in the same spirit of the
ItemUtility offered in the Nuix API.</div>
</th>
</tr>
<tr id="i72" class="altColor">
<tr id="i73" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/SuperUtilities.html" title="class in com.nuix.superutilities">SuperUtilities</a></td>
<th class="colLast" scope="row">
<div class="block">Serves as the entry point to most of the functionality.</div>
</th>
</tr>
<tr id="i73" class="rowColor">
<tr id="i74" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/annotations/TagEvent.html" title="class in com.nuix.superutilities.annotations">TagEvent</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i74" class="altColor">
<tr id="i75" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/export/TemplateExporter.html" title="class in com.nuix.superutilities.export">TemplateExporter</a></td>
<th class="colLast" scope="row">
<div class="block">Experimental class attempting to integrate Ruby ERB templates with Java by using JRuby to
compile a Ruby method which is capable of rendering an ERB and injecting it with Java data.</div>
</th>
</tr>
<tr id="i75" class="rowColor">
<tr id="i76" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/TermExpander.html" title="class in com.nuix.superutilities.misc">TermExpander</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
<tr id="i76" class="altColor">
<tr id="i77" class="rowColor">
<td class="colFirst"><a href="com/nuix/superutilities/cases/WorkFunctionErrorEvent.html" title="class in com.nuix.superutilities.cases">WorkFunctionErrorEvent</a></td>
<th class="colLast" scope="row">
<div class="block">This class is used to provide a callback information regarding an exception encountered by <a href="com/nuix/superutilities/cases/BulkCaseProcessor.html" title="class in com.nuix.superutilities.cases"><code>BulkCaseProcessor</code></a> while
executing code provided in user code.</div>
</th>
</tr>
<tr id="i77" class="rowColor">
<tr id="i78" class="altColor">
<td class="colFirst"><a href="com/nuix/superutilities/misc/ZipHelper.html" title="class in com.nuix.superutilities.misc">ZipHelper</a></td>
<th class="colLast" scope="row">&nbsp;</th>
</tr>
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<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/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/query/QueryHelper.html" title="class in com.nuix.superutilities.query">QueryHelper</a></li>
Expand Down
Loading

0 comments on commit b4607e7

Please sign in to comment.