Skip to content

Commit a887303

Browse files
JuicyDragonJuicyDragon
committed
Javadoc refresh
1 parent 0985562 commit a887303

File tree

3 files changed

+65
-10
lines changed

3 files changed

+65
-10
lines changed

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

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
catch(err) {
1818
}
1919
//-->
20-
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":10,"i19":9,"i20":10,"i21":10,"i22":9};
20+
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":10,"i20":9,"i21":10,"i22":10,"i23":9,"i24":9};
2121
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2222
var altColor = "altColor";
2323
var rowColor = "rowColor";
@@ -215,65 +215,77 @@ <h3>Method Summary</h3>
215215
</td>
216216
</tr>
217217
<tr id="i13" class="rowColor">
218+
<td class="colFirst"><code>static java.lang.String</code></td>
219+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#getHtmlText-java.lang.String-">getHtmlText</a></span>(java.lang.String&nbsp;htmlSource)</code>
220+
<div class="block">Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.</div>
221+
</td>
222+
</tr>
223+
<tr id="i14" class="altColor">
218224
<td class="colFirst"><code>static <a href="../../../../com/nuix/superutilities/misc/FormatUtility.html" title="class in com.nuix.superutilities.misc">FormatUtility</a></code></td>
219225
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#getInstance--">getInstance</a></span>()</code>&nbsp;</td>
220226
</tr>
221-
<tr id="i14" class="altColor">
227+
<tr id="i15" class="rowColor">
222228
<td class="colFirst"><code>static double</code></td>
223229
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#getUnitBase--">getUnitBase</a></span>()</code>
224230
<div class="block">Gets the unit base which will be used in size calculations.</div>
225231
</td>
226232
</tr>
227-
<tr id="i15" class="rowColor">
233+
<tr id="i16" class="altColor">
228234
<td class="colFirst"><code>static boolean</code></td>
229235
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#getUseSIUnits--">getUseSIUnits</a></span>()</code>
230236
<div class="block">Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.</div>
231237
</td>
232238
</tr>
233-
<tr id="i16" class="altColor">
239+
<tr id="i17" class="rowColor">
234240
<td class="colFirst"><code>static byte[]</code></td>
235241
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#hexToBytes-java.lang.String-">hexToBytes</a></span>(java.lang.String&nbsp;hex)</code>
236242
<div class="block">Convenience method for converting hex string to byte array.</div>
237243
</td>
238244
</tr>
239-
<tr id="i17" class="rowColor">
245+
<tr id="i18" class="altColor">
240246
<td class="colFirst"><code>static java.io.File</code></td>
241247
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#makeGuidPath-nuix.Item-java.io.File-java.lang.String-">makeGuidPath</a></span>(nuix.Item&nbsp;item,
242248
java.io.File&nbsp;rootDirectory,
243249
java.lang.String&nbsp;extension)</code>&nbsp;</td>
244250
</tr>
245-
<tr id="i18" class="altColor">
251+
<tr id="i19" class="rowColor">
246252
<td class="colFirst"><code>java.lang.String</code></td>
247253
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#resolvePlaceholders-java.lang.String-java.util.Map-">resolvePlaceholders</a></span>(java.lang.String&nbsp;template,
248254
java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;placeholderValues)</code>
249255
<div class="block">Simple method to replace place holders with values in a template string.</div>
250256
</td>
251257
</tr>
252-
<tr id="i19" class="rowColor">
258+
<tr id="i20" class="altColor">
253259
<td class="colFirst"><code>static double</code></td>
254260
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#round-double-int-">round</a></span>(double&nbsp;value,
255261
int&nbsp;numberOfDigitsAfterDecimalPoint)</code>
256262
<div class="block">Helper method for rounding a decimal value to a particular number of decimal places.</div>
257263
</td>
258264
</tr>
259-
<tr id="i20" class="altColor">
265+
<tr id="i21" class="rowColor">
260266
<td class="colFirst"><code>java.lang.String</code></td>
261267
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#secondsToElapsedString-java.lang.Double-">secondsToElapsedString</a></span>(java.lang.Double&nbsp;offsetSeconds)</code>
262268
<div class="block">Converts a value representing some number of seconds to an "elapsed" string.</div>
263269
</td>
264270
</tr>
265-
<tr id="i21" class="rowColor">
271+
<tr id="i22" class="altColor">
266272
<td class="colFirst"><code>java.lang.String</code></td>
267273
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#secondsToElapsedString-long-">secondsToElapsedString</a></span>(long&nbsp;offsetSeconds)</code>
268274
<div class="block">Converts a value representing some number of seconds to an "elapsed" string.</div>
269275
</td>
270276
</tr>
271-
<tr id="i22" class="altColor">
277+
<tr id="i23" class="rowColor">
272278
<td class="colFirst"><code>static void</code></td>
273279
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#setUseSIUnits-boolean-">setUseSIUnits</a></span>(boolean&nbsp;useSIUnits)</code>
274280
<div class="block">Gets value indicating whether SI Unit (1000 Bytes = 1 Kilo Byte) will be used.</div>
275281
</td>
276282
</tr>
283+
<tr id="i24" class="altColor">
284+
<td class="colFirst"><code>static java.util.List&lt;java.lang.String&gt;</code></td>
285+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/nuix/superutilities/misc/FormatUtility.html#tokenizeText-java.lang.String-">tokenizeText</a></span>(java.lang.String&nbsp;inputText)</code>
286+
<div class="block">Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.</div>
287+
</td>
288+
</tr>
277289
</table>
278290
<ul class="blockList">
279291
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@@ -619,6 +631,41 @@ <h4>round</h4>
619631
</dl>
620632
</li>
621633
</ul>
634+
<a name="tokenizeText-java.lang.String-">
635+
<!-- -->
636+
</a>
637+
<ul class="blockList">
638+
<li class="blockList">
639+
<h4>tokenizeText</h4>
640+
<pre>public static&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;tokenizeText(java.lang.String&nbsp;inputText)
641+
throws java.lang.Exception</pre>
642+
<div class="block">Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.</div>
643+
<dl>
644+
<dt><span class="paramLabel">Parameters:</span></dt>
645+
<dd><code>inputText</code> - The text to tokenize</dd>
646+
<dt><span class="returnLabel">Returns:</span></dt>
647+
<dd>A list of tokens parsed from inputText by Lucene.</dd>
648+
<dt><span class="throwsLabel">Throws:</span></dt>
649+
<dd><code>java.lang.Exception</code> - Most likely thrown if Lucene tokenizer encounters a problem.</dd>
650+
</dl>
651+
</li>
652+
</ul>
653+
<a name="getHtmlText-java.lang.String-">
654+
<!-- -->
655+
</a>
656+
<ul class="blockList">
657+
<li class="blockList">
658+
<h4>getHtmlText</h4>
659+
<pre>public static&nbsp;java.lang.String&nbsp;getHtmlText(java.lang.String&nbsp;htmlSource)</pre>
660+
<div class="block">Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.</div>
661+
<dl>
662+
<dt><span class="paramLabel">Parameters:</span></dt>
663+
<dd><code>htmlSource</code> - The HTML source code to parse the text from.</dd>
664+
<dt><span class="returnLabel">Returns:</span></dt>
665+
<dd>The "rendered text" of the provided HTML source code.</dd>
666+
</dl>
667+
</li>
668+
</ul>
622669
<a name="formatAsTextualTable-java.util.List-">
623670
<!-- -->
624671
</a>

‎docs/index-files/index-19.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,10 @@ <h2 class="title">T</h2>
118118
<dd>&nbsp;</dd>
119119
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html#toHeaderLine-java.util.List-">toHeaderLine(List&lt;String&gt;)</a></span> - Static method in class com.nuix.superutilities.loadfiles.<a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFile</a></dt>
120120
<dd>&nbsp;</dd>
121+
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/FormatUtility.html#tokenizeText-java.lang.String-">tokenizeText(String)</a></span> - Static method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/FormatUtility.html" title="class in com.nuix.superutilities.misc">FormatUtility</a></dt>
122+
<dd>
123+
<div class="block">Convenience method for using Lucene's StandardTokenizer to tokenize arbitrary text.</div>
124+
</dd>
121125
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html#toLine-java.util.LinkedHashMap-">toLine(LinkedHashMap&lt;String, String&gt;)</a></span> - Static method in class com.nuix.superutilities.loadfiles.<a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFile</a></dt>
122126
<dd>&nbsp;</dd>
123127
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html#toLine-java.lang.String:A-">toLine(String[])</a></span> - Static method in class com.nuix.superutilities.loadfiles.<a href="../com/nuix/superutilities/loadfiles/DatLoadFile.html" title="class in com.nuix.superutilities.loadfiles">DatLoadFile</a></dt>

‎docs/index-files/index-7.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,10 @@ <h2 class="title">G</h2>
341341
<dd>&nbsp;</dd>
342342
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/cases/CaseLockInfo.html#getHost--">getHost()</a></span> - Method in class com.nuix.superutilities.cases.<a href="../com/nuix/superutilities/cases/CaseLockInfo.html" title="class in com.nuix.superutilities.cases">CaseLockInfo</a></dt>
343343
<dd>&nbsp;</dd>
344+
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/misc/FormatUtility.html#getHtmlText-java.lang.String-">getHtmlText(String)</a></span> - Static method in class com.nuix.superutilities.misc.<a href="../com/nuix/superutilities/misc/FormatUtility.html" title="class in com.nuix.superutilities.misc">FormatUtility</a></dt>
345+
<dd>
346+
<div class="block">Convenience method for getting the "rendered text" (text as seen in browser) of HTML source code using Jsoup.</div>
347+
</dd>
344348
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/loadfiles/OptRecord.html#getId--">getId()</a></span> - Method in class com.nuix.superutilities.loadfiles.<a href="../com/nuix/superutilities/loadfiles/OptRecord.html" title="class in com.nuix.superutilities.loadfiles">OptRecord</a></dt>
345349
<dd>&nbsp;</dd>
346350
<dt><span class="memberNameLink"><a href="../com/nuix/superutilities/export/JsonExporter.html#getIncludeChildGuids--">getIncludeChildGuids()</a></span> - Method in class com.nuix.superutilities.export.<a href="../com/nuix/superutilities/export/JsonExporter.html" title="class in com.nuix.superutilities.export">JsonExporter</a></dt>

0 commit comments

Comments
 (0)