blob: 53e5f669f195f319156b49a67211450a5f7b77e1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>JOrphanUtils (Apache JMeter dist API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.jorphan.util, class: JOrphanUtils">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache JMeter</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.jorphan.util</a></div>
<h1 title="Class JOrphanUtils" class="title">Class JOrphanUtils</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.jorphan.util.JOrphanUtils</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">JOrphanUtils</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">This class contains frequently-used static utility methods.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#baToHexBytes(byte%5B%5D)" class="member-name-link">baToHexBytes</a><wbr>(byte[]&nbsp;ba)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Convert binary byte array to hex string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#baToHexString(byte%5B%5D)" class="member-name-link">baToHexString</a><wbr>(byte[]&nbsp;ba)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Convert binary byte array to hex string.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#baToHexString(byte%5B%5D,char)" class="member-name-link">baToHexString</a><wbr>(byte[]&nbsp;ba,
char&nbsp;separator)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Convert binary byte array to hex string.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#booleanToSTRING(boolean)" class="member-name-link">booleanToSTRING</a><wbr>(boolean&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Convert a boolean to its upper case string representation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#canSafelyWriteToFolder(java.io.File)" class="member-name-link">canSafelyWriteToFolder</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check whether we can write to a folder.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#canSafelyWriteToFolder(java.io.File,boolean)" class="member-name-link">canSafelyWriteToFolder</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
boolean&nbsp;deleteFolderContent)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check whether we can write to a folder.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#canSafelyWriteToFolder(java.io.File,boolean,java.io.FileFilter)" class="member-name-link">canSafelyWriteToFolder</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
boolean&nbsp;deleteFolderIfExists,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;exporterFileFilter)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check whether we can write to a folder.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#canSafelyWriteToFolder(java.io.File,java.io.FileFilter)" class="member-name-link">canSafelyWriteToFolder</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check whether we can write to a folder.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#closeQuietly(java.io.Closeable)" class="member-name-link">closeQuietly</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a>&nbsp;cl)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Close a Closeable with no error thrown</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#closeQuietly(java.net.ServerSocket)" class="member-name-link">closeQuietly</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html" title="class or interface in java.net" class="external-link">ServerSocket</a>&nbsp;sock)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">close a Socket with no error thrown</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#closeQuietly(java.net.Socket)" class="member-name-link">closeQuietly</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a>&nbsp;sock)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">close a Socket with no error thrown</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#displayThreads(boolean)" class="member-name-link">displayThreads</a><wbr>(boolean&nbsp;includeDaemons)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Display currently running threads on system.out
This may be expensive to run.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#formatDuration(long)" class="member-name-link">formatDuration</a><wbr>(long&nbsp;elapsedSec)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns duration formatted with format HH:mm:ss.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#generateRandomAlphanumericPassword(int)" class="member-name-link">generateRandomAlphanumericPassword</a><wbr>(int&nbsp;length)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Random alphanumeric password of a given length.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static byte[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getByteArraySlice(byte%5B%5D,int,int)" class="member-name-link">getByteArraySlice</a><wbr>(byte[]&nbsp;array,
int&nbsp;begin,
int&nbsp;end)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns a slice of a byte array.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isBlank(java.lang.String)" class="member-name-link">isBlank</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check that value is empty (""), <code>null</code> or whitespace only.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isXML(byte%5B%5D)" class="member-name-link">isXML</a><wbr>(byte[]&nbsp;target)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Detects if some content starts with the standard XML prefix.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#leftAlign(java.lang.StringBuilder,int)" class="member-name-link">leftAlign</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;in,
int&nbsp;len)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Left aligns some text in a StringBuilder N.B.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#nullifyIfEmptyTrimmed(java.lang.String)" class="member-name-link">nullifyIfEmptyTrimmed</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns <code>null</code> if input is empty, <code>null</code> or contains spaces only</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#read(java.io.InputStream,byte%5B%5D,int,int)" class="member-name-link">read</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;is,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Read as much as possible into buffer.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#replaceAllChars(java.lang.String,char,java.lang.String)" class="member-name-link">replaceAllChars</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
char&nbsp;search,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replace)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Version of String.replaceAll() for JDK1.3
See below for another version which replaces strings rather than chars
and provides a fast path which does not allocate memory</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#replaceAllWithRegex(java.lang.String,java.lang.String,java.lang.String,boolean)" class="member-name-link">replaceAllWithRegex</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;regex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replacement,
boolean&nbsp;caseSensitive)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Replace in source all matches of regex by replacement taking
into account case if caseSensitive is true</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#replaceFirst(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">replaceFirst</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;search,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replace)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Simple-minded String.replace() for JDK1.3 Should probably be recoded...</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#replaceValue(java.lang.String,java.lang.String,boolean,java.lang.String,java.util.function.Consumer)" class="member-name-link">replaceValue</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;regex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replaceBy,
boolean&nbsp;caseSensitive,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;setter)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Replace all occurrences of <code>regex</code> in <code>value</code> by <code>replaceBy</code> if <code>value</code> is not blank.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rightAlign(java.lang.StringBuilder,int)" class="member-name-link">rightAlign</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;in,
int&nbsp;len)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Right aligns some text in a StringBuilder N.B.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#split(java.lang.String,java.lang.String)" class="member-name-link">split</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splitChar)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#split(java.lang.String,java.lang.String,boolean)" class="member-name-link">split</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splitChar,
boolean&nbsp;truncate)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">This is <em>almost</em> equivalent to the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#split-java.lang.String-" title="class or interface in java.lang" class="external-link"><code>String.split(String)</code></a> method in JDK 1.4.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#split(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">split</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;delims,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;def)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Takes a String and a tokenizer character string, and returns a new array of
strings of the string split by the tokenizer character(s).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#startsWith(byte%5B%5D,byte%5B%5D,int)" class="member-name-link">startsWith</a><wbr>(byte[]&nbsp;target,
byte[]&nbsp;search,
int&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Check if a byte array starts with the given byte array.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#substitute(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">substitute</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sub)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Replace all patterns in a String</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#trim(java.lang.String,java.lang.String)" class="member-name-link">trim</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;delims)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Trim a string by the tokens provided.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unsplit(java.lang.Object%5B%5D,java.lang.Object)" class="member-name-link">unsplit</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;splitChar)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Takes an array of strings and a tokenizer character, and returns a string
of all the strings concatenated with the tokenizer string in between each
one.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#write(byte%5B%5D,java.io.OutputStream)" class="member-name-link">write</a><wbr>(byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;output)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Write data to an output stream in chunks with a maximum size of 4K.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="split(java.lang.String,java.lang.String,boolean)">
<h3>split</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">split</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splitChar,
boolean&nbsp;truncate)</span></div>
<div class="block">This is <em>almost</em> equivalent to the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#split-java.lang.String-" title="class or interface in java.lang" class="external-link"><code>String.split(String)</code></a> method in JDK 1.4. It is
here to enable us to support earlier JDKs.
<p>
Note that unlike JDK1.4 split(), it optionally ignores leading split Characters,
and the splitChar parameter is not a Regular expression
<p>
This piece of code used to be part of JMeterUtils, but was moved here
because some JOrphan classes use it too.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>splittee</code> - String to be split</dd>
<dd><code>splitChar</code> - Character(s) to split the string on, these are treated as a single unit</dd>
<dd><code>truncate</code> - Should adjacent and leading/trailing splitChars be removed?</dd>
<dt>Returns:</dt>
<dd>Array of all the tokens; empty if the input string is <code>null</code> or the splitChar is <code>null</code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#split(java.lang.String,java.lang.String,java.lang.String)"><code>split(String, String, String)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="split(java.lang.String,java.lang.String)">
<h3>split</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">split</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splitChar)</span></div>
</section>
</li>
<li>
<section class="detail" id="split(java.lang.String,java.lang.String,java.lang.String)">
<h3>split</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]</span>&nbsp;<span class="element-name">split</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;delims,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;def)</span></div>
<div class="block">Takes a String and a tokenizer character string, and returns a new array of
strings of the string split by the tokenizer character(s).
<p>
Trailing delimiters are significant (unless the default = null)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>splittee</code> - String to be split.</dd>
<dd><code>delims</code> - Delimiter character(s) to split the string on</dd>
<dd><code>def</code> - Default value to place between two split chars that have
nothing between them. If null, then ignore omitted elements.</dd>
<dt>Returns:</dt>
<dd>Array of all the tokens.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if splittee or delims are <code>null</code></dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#split(java.lang.String,java.lang.String,boolean)"><code>split(String, String, boolean)</code></a></li>
<li><a href="#split(java.lang.String,java.lang.String)"><code><p>
This is a rewritten version of JMeterUtils.split()</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="rightAlign(java.lang.StringBuilder,int)">
<h3>rightAlign</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></span>&nbsp;<span class="element-name">rightAlign</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;in,
int&nbsp;len)</span></div>
<div class="block">Right aligns some text in a StringBuilder N.B. modifies the input builder</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>in</code> - StringBuilder containing some text</dd>
<dd><code>len</code> - output length desired</dd>
<dt>Returns:</dt>
<dd>input StringBuilder, with leading spaces</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="leftAlign(java.lang.StringBuilder,int)">
<h3>leftAlign</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></span>&nbsp;<span class="element-name">leftAlign</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;in,
int&nbsp;len)</span></div>
<div class="block">Left aligns some text in a StringBuilder N.B. modifies the input builder</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>in</code> - StringBuilder containing some text</dd>
<dd><code>len</code> - output length desired</dd>
<dt>Returns:</dt>
<dd>input StringBuilder, with trailing spaces</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="booleanToSTRING(boolean)">
<h3>booleanToSTRING</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">booleanToSTRING</span><wbr><span class="parameters">(boolean&nbsp;value)</span></div>
<div class="block">Convert a boolean to its upper case string representation.
Equivalent to Boolean.valueOf(boolean).toString().toUpperCase().</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - boolean to convert</dd>
<dt>Returns:</dt>
<dd>"TRUE" or "FALSE"</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="replaceFirst(java.lang.String,java.lang.String,java.lang.String)">
<h3>replaceFirst</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">replaceFirst</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;search,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replace)</span></div>
<div class="block">Simple-minded String.replace() for JDK1.3 Should probably be recoded...</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - input string</dd>
<dd><code>search</code> - string to look for (no regular expressions)</dd>
<dd><code>replace</code> - string to replace the search string</dd>
<dt>Returns:</dt>
<dd>the output string</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="replaceAllChars(java.lang.String,char,java.lang.String)">
<h3>replaceAllChars</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">replaceAllChars</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
char&nbsp;search,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replace)</span></div>
<div class="block">Version of String.replaceAll() for JDK1.3
See below for another version which replaces strings rather than chars
and provides a fast path which does not allocate memory</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - input string</dd>
<dd><code>search</code> - char to look for (no regular expressions)</dd>
<dd><code>replace</code> - string to replace the search string</dd>
<dt>Returns:</dt>
<dd>the output string</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="substitute(java.lang.String,java.lang.String,java.lang.String)">
<h3>substitute</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">substitute</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pattern,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sub)</span></div>
<div class="block">Replace all patterns in a String</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - - string to be transformed</dd>
<dd><code>pattern</code> - - pattern to replace</dd>
<dd><code>sub</code> - - replacement</dd>
<dt>Returns:</dt>
<dd>the updated string</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#replaceAll-java.lang.String-java.lang.String-" title="class or interface in java.lang" class="external-link"><code>- JDK1.4 only</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="trim(java.lang.String,java.lang.String)">
<h3>trim</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">trim</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;delims)</span></div>
<div class="block">Trim a string by the tokens provided.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - string to trim</dd>
<dd><code>delims</code> - list of delimiters</dd>
<dt>Returns:</dt>
<dd>input trimmed at the first delimiter</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getByteArraySlice(byte[],int,int)">
<h3>getByteArraySlice</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">getByteArraySlice</span><wbr><span class="parameters">(byte[]&nbsp;array,
int&nbsp;begin,
int&nbsp;end)</span></div>
<div class="block">Returns a slice of a byte array.
<p>
TODO - add bounds checking?</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>array</code> - input array</dd>
<dd><code>begin</code> - start of slice</dd>
<dd><code>end</code> - end of slice</dd>
<dt>Returns:</dt>
<dd>slice from the input array</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="closeQuietly(java.io.Closeable)">
<h3>closeQuietly</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">closeQuietly</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a>&nbsp;cl)</span></div>
<div class="block">Close a Closeable with no error thrown</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cl</code> - - Closeable (may be null)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="closeQuietly(java.net.Socket)">
<h3>closeQuietly</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">closeQuietly</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html" title="class or interface in java.net" class="external-link">Socket</a>&nbsp;sock)</span></div>
<div class="block">close a Socket with no error thrown</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>sock</code> - - Socket (may be null)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="closeQuietly(java.net.ServerSocket)">
<h3>closeQuietly</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">closeQuietly</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html" title="class or interface in java.net" class="external-link">ServerSocket</a>&nbsp;sock)</span></div>
<div class="block">close a Socket with no error thrown</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>sock</code> - - ServerSocket (may be null)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="startsWith(byte[],byte[],int)">
<h3>startsWith</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">startsWith</span><wbr><span class="parameters">(byte[]&nbsp;target,
byte[]&nbsp;search,
int&nbsp;offset)</span></div>
<div class="block">Check if a byte array starts with the given byte array.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>target</code> - array to scan</dd>
<dd><code>search</code> - array to search for</dd>
<dd><code>offset</code> - starting offset (&ge;0)</dd>
<dt>Returns:</dt>
<dd>true if the search array matches the target at the current offset</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#startsWith-java.lang.String-int-" title="class or interface in java.lang" class="external-link"><code>String.startsWith(String, int)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isXML(byte[])">
<h3>isXML</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isXML</span><wbr><span class="parameters">(byte[]&nbsp;target)</span></div>
<div class="block">Detects if some content starts with the standard XML prefix.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>target</code> - the content to check</dd>
<dt>Returns:</dt>
<dd>true if the document starts with the standard XML prefix.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="baToHexString(byte[])">
<h3>baToHexString</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">baToHexString</span><wbr><span class="parameters">(byte[]&nbsp;ba)</span></div>
<div class="block">Convert binary byte array to hex string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ba</code> - input binary byte array</dd>
<dt>Returns:</dt>
<dd>hex representation of binary input</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="baToHexString(byte[],char)">
<h3>baToHexString</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">baToHexString</span><wbr><span class="parameters">(byte[]&nbsp;ba,
char&nbsp;separator)</span></div>
<div class="block">Convert binary byte array to hex string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ba</code> - input binary byte array</dd>
<dd><code>separator</code> - the separator to be added between pairs of hex digits</dd>
<dt>Returns:</dt>
<dd>hex representation of binary input</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="baToHexBytes(byte[])">
<h3>baToHexBytes</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name">baToHexBytes</span><wbr><span class="parameters">(byte[]&nbsp;ba)</span></div>
<div class="block">Convert binary byte array to hex string.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>ba</code> - input binary byte array</dd>
<dt>Returns:</dt>
<dd>hex representation of binary input</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="read(java.io.InputStream,byte[],int,int)">
<h3>read</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">read</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;is,
byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;length)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Read as much as possible into buffer.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>is</code> - the stream to read from</dd>
<dd><code>buffer</code> - output buffer</dd>
<dd><code>offset</code> - offset into buffer</dd>
<dd><code>length</code> - number of bytes to read</dd>
<dt>Returns:</dt>
<dd>the number of bytes actually read</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if some I/O errors occur</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="displayThreads(boolean)">
<h3>displayThreads</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">displayThreads</span><wbr><span class="parameters">(boolean&nbsp;includeDaemons)</span></div>
<div class="block">Display currently running threads on system.out
This may be expensive to run.
Mainly designed for use at the end of a non-GUI test to check for threads that might prevent the JVM from exiting.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>includeDaemons</code> - whether to include daemon threads or not.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nullifyIfEmptyTrimmed(java.lang.String)">
<h3>nullifyIfEmptyTrimmed</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">nullifyIfEmptyTrimmed</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input)</span></div>
<div class="block">Returns <code>null</code> if input is empty, <code>null</code> or contains spaces only</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>input</code> - String</dd>
<dt>Returns:</dt>
<dd>trimmed input or <code>null</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isBlank(java.lang.String)">
<h3>isBlank</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isBlank</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</span></div>
<div class="block">Check that value is empty (""), <code>null</code> or whitespace only.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - Value</dd>
<dt>Returns:</dt>
<dd><code>true</code> if the String is not empty (""), not <code>null</code> and not whitespace only.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="write(byte[],java.io.OutputStream)">
<h3>write</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">write</span><wbr><span class="parameters">(byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;output)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Write data to an output stream in chunks with a maximum size of 4K.
This is to avoid OutOfMemory issues if the data buffer is very large
and the JVM needs to copy the buffer for use by native code.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>data</code> - the buffer to be written</dd>
<dd><code>output</code> - the output stream to use</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if there is a problem writing the data</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="formatDuration(long)">
<h3>formatDuration</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">formatDuration</span><wbr><span class="parameters">(long&nbsp;elapsedSec)</span></div>
<div class="block">Returns duration formatted with format HH:mm:ss.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>elapsedSec</code> - long elapsed time in seconds</dd>
<dt>Returns:</dt>
<dd>String formatted with format HH:mm:ss</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canSafelyWriteToFolder(java.io.File)">
<h3>canSafelyWriteToFolder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">canSafelyWriteToFolder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder)</span></div>
<div class="block">Check whether we can write to a folder.
A folder can be written to if if does not contain any file or folder
Throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> if folder cannot be written to either:
<ul>
<li>Because it exists but is not a folder</li>
<li>Because it exists but is not empty</li>
<li>Because it does not exist but cannot be created</li>
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>folder</code> - to check</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when folder can't be written to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canSafelyWriteToFolder(java.io.File,java.io.FileFilter)">
<h3>canSafelyWriteToFolder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">canSafelyWriteToFolder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;fileFilter)</span></div>
<div class="block">Check whether we can write to a folder.
A folder can be written to if folder.listFiles(exporterFileFilter) does not return any file or folder.
Throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> if folder cannot be written to either:
<ul>
<li>Because it exists but is not a folder</li>
<li>Because it exists but is not empty using folder.listFiles(exporterFileFilter)</li>
<li>Because it does not exist but cannot be created</li>
</ul></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>folder</code> - to check</dd>
<dd><code>fileFilter</code> - used to filter listing of folder</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when folder can't be written to</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canSafelyWriteToFolder(java.io.File,boolean)">
<h3>canSafelyWriteToFolder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">canSafelyWriteToFolder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
boolean&nbsp;deleteFolderContent)</span></div>
<div class="block">Check whether we can write to a folder. If <code>deleteFolderContent</code> is <code>true</code> the folder or file with
the same name will be emptied or deleted.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>folder</code> - to check</dd>
<dd><code>deleteFolderContent</code> - flag whether the folder should be emptied or a file with the same name deleted</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when folder can't be written to
Throw IllegalArgumentException if folder cannot be written</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="canSafelyWriteToFolder(java.io.File,boolean,java.io.FileFilter)">
<h3>canSafelyWriteToFolder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">canSafelyWriteToFolder</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;folder,
boolean&nbsp;deleteFolderIfExists,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/FileFilter.html" title="class or interface in java.io" class="external-link">FileFilter</a>&nbsp;exporterFileFilter)</span></div>
<div class="block">Check whether we can write to a folder.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>folder</code> - which should be checked for writability and emptiness</dd>
<dd><code>deleteFolderIfExists</code> - flag whether the folder should be emptied or a file with the same name deleted</dd>
<dd><code>exporterFileFilter</code> - used for filtering listing of the folder</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - when folder can't be written to. That could have the following reasons:
<ul>
<li>it exists but is not a folder</li>
<li>it exists but is not empty</li>
<li>it does not exist but cannot be created</li>
</ul></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="replaceAllWithRegex(java.lang.String,java.lang.String,java.lang.String,boolean)">
<h3>replaceAllWithRegex</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]</span>&nbsp;<span class="element-name">replaceAllWithRegex</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;regex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replacement,
boolean&nbsp;caseSensitive)</span></div>
<div class="block">Replace in source all matches of regex by replacement taking
into account case if caseSensitive is true</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - Source text</dd>
<dd><code>regex</code> - Regular expression</dd>
<dd><code>replacement</code> - Replacement text to which function applies a quoting</dd>
<dd><code>caseSensitive</code> - is case taken into account</dd>
<dt>Returns:</dt>
<dd>array of Object where first row is the replaced text, second row is the number of replacement that occurred</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="replaceValue(java.lang.String,java.lang.String,boolean,java.lang.String,java.util.function.Consumer)">
<h3>replaceValue</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">replaceValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;regex,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;replaceBy,
boolean&nbsp;caseSensitive,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;setter)</span></div>
<div class="block">Replace all occurrences of <code>regex</code> in <code>value</code> by <code>replaceBy</code> if <code>value</code> is not blank.
The replaced text is fed into the <code>setter</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>regex</code> - Regular expression that is used for the search</dd>
<dd><code>replaceBy</code> - value that is used for replacement</dd>
<dd><code>caseSensitive</code> - flag whether the regex should be applied case sensitive</dd>
<dd><code>value</code> - in which the replacement takes place</dd>
<dd><code>setter</code> - that gets called with the replaced value</dd>
<dt>Returns:</dt>
<dd>number of matches that were replaced</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="unsplit(java.lang.Object[],java.lang.Object)">
<h3>unsplit</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">unsplit</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[]&nbsp;splittee,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;splitChar)</span></div>
<div class="block">Takes an array of strings and a tokenizer character, and returns a string
of all the strings concatenated with the tokenizer string in between each
one.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>splittee</code> - Array of Objects to be concatenated.</dd>
<dd><code>splitChar</code> - Object to unsplit the strings with.</dd>
<dt>Returns:</dt>
<dd>Array of all the tokens.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="generateRandomAlphanumericPassword(int)">
<h3>generateRandomAlphanumericPassword</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">generateRandomAlphanumericPassword</span><wbr><span class="parameters">(int&nbsp;length)</span></div>
<div class="block">Random alphanumeric password of a given length.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>length</code> - Max length of password</dd>
<dt>Returns:</dt>
<dd>String random password</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>