Package org.apache.jorphan.util
Class JOrphanUtils
java.lang.Object
org.apache.jorphan.util.JOrphanUtils
This class contains frequently-used static utility methods.
-
Method Summary
Modifier and TypeMethodDescriptionstatic byte[]baToHexBytes(byte[] ba) Convert binary byte array to hex string.static StringbaToHexString(byte[] ba) Convert binary byte array to hex string.static StringbaToHexString(byte[] ba, char separator) Convert binary byte array to hex string.static StringbooleanToSTRING(boolean value) Convert a boolean to its upper case string representation.static voidcanSafelyWriteToFolder(File folder) Check whether we can write to a folder.static voidcanSafelyWriteToFolder(File folder, boolean deleteFolderContent) Check whether we can write to a folder.static voidcanSafelyWriteToFolder(File folder, boolean deleteFolderIfExists, FileFilter exporterFileFilter) Check whether we can write to a folder.static voidcanSafelyWriteToFolder(File folder, FileFilter fileFilter) Check whether we can write to a folder.static voidClose a Closeable with no error thrownstatic voidcloseQuietly(ServerSocket sock) close a Socket with no error thrownstatic voidcloseQuietly(Socket sock) close a Socket with no error thrownstatic voiddisplayThreads(boolean includeDaemons) Display currently running threads on system.out This may be expensive to run.static StringformatDuration(long elapsedSec) Returns duration formatted with format HH:mm:ss.static StringgenerateRandomAlphanumericPassword(int length) Random alphanumeric password of a given length.static byte[]getByteArraySlice(byte[] array, int begin, int end) Returns a slice of a byte array.static booleanCheck that value is empty (""),nullor whitespace only.static booleanisXML(byte[] target) Detects if some content starts with the standard XML prefix.static StringBuilderleftAlign(StringBuilder in, int len) Left aligns some text in a StringBuilder N.B.static StringnullifyIfEmptyTrimmed(String input) Returnsnullif input is empty,nullor contains spaces onlystatic intread(InputStream is, byte[] buffer, int offset, int length) Read as much as possible into buffer.static StringreplaceAllChars(String source, char search, String replace) 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 memorystatic Object[]replaceAllWithRegex(String source, String regex, String replacement, boolean caseSensitive) Replace in source all matches of regex by replacement taking into account case if caseSensitive is truestatic StringreplaceFirst(String source, String search, String replace) Simple-minded String.replace() for JDK1.3 Should probably be recoded...static intreplaceValue(String regex, String replaceBy, boolean caseSensitive, String value, Consumer<? super String> setter) Replace all occurrences ofregexinvaluebyreplaceByifvalueis not blank.static StringBuilderrightAlign(StringBuilder in, int len) Right aligns some text in a StringBuilder N.B.static String[]static String[]This is almost equivalent to theString.split(String)method in JDK 1.4.static String[]Takes a String and a tokenizer character string, and returns a new array of strings of the string split by the tokenizer character(s).static booleanstartsWith(byte[] target, byte[] search, int offset) Check if a byte array starts with the given byte array.static Stringsubstitute(String input, String pattern, String sub) Replace all patterns in a Stringstatic StringTrim a string by the tokens provided.static StringTakes 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.static voidwrite(byte[] data, OutputStream output) Write data to an output stream in chunks with a maximum size of 4K.
-
Method Details
-
split
This is almost equivalent to theString.split(String)method in JDK 1.4. It is here to enable us to support earlier JDKs.Note that unlike JDK1.4 split(), it optionally ignores leading split Characters, and the splitChar parameter is not a Regular expression
This piece of code used to be part of JMeterUtils, but was moved here because some JOrphan classes use it too.
- Parameters:
splittee- String to be splitsplitChar- Character(s) to split the string on, these are treated as a single unittruncate- Should adjacent and leading/trailing splitChars be removed?- Returns:
- Array of all the tokens; empty if the input string is
nullor the splitChar isnull - See Also:
-
split
-
split
Takes a String and a tokenizer character string, and returns a new array of strings of the string split by the tokenizer character(s).Trailing delimiters are significant (unless the default = null)
- Parameters:
splittee- String to be split.delims- Delimiter character(s) to split the string ondef- Default value to place between two split chars that have nothing between them. If null, then ignore omitted elements.- Returns:
- Array of all the tokens.
- Throws:
NullPointerException- if splittee or delims arenull- See Also:
-
rightAlign
Right aligns some text in a StringBuilder N.B. modifies the input builder- Parameters:
in- StringBuilder containing some textlen- output length desired- Returns:
- input StringBuilder, with leading spaces
-
leftAlign
Left aligns some text in a StringBuilder N.B. modifies the input builder- Parameters:
in- StringBuilder containing some textlen- output length desired- Returns:
- input StringBuilder, with trailing spaces
-
booleanToSTRING
Convert a boolean to its upper case string representation. Equivalent to Boolean.valueOf(boolean).toString().toUpperCase().- Parameters:
value- boolean to convert- Returns:
- "TRUE" or "FALSE"
-
replaceFirst
Simple-minded String.replace() for JDK1.3 Should probably be recoded...- Parameters:
source- input stringsearch- string to look for (no regular expressions)replace- string to replace the search string- Returns:
- the output string
-
replaceAllChars
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- Parameters:
source- input stringsearch- char to look for (no regular expressions)replace- string to replace the search string- Returns:
- the output string
-
substitute
Replace all patterns in a String- Parameters:
input- - string to be transformedpattern- - pattern to replacesub- - replacement- Returns:
- the updated string
- See Also:
-
trim
Trim a string by the tokens provided.- Parameters:
input- string to trimdelims- list of delimiters- Returns:
- input trimmed at the first delimiter
-
getByteArraySlice
public static byte[] getByteArraySlice(byte[] array, int begin, int end) Returns a slice of a byte array.TODO - add bounds checking?
- Parameters:
array- input arraybegin- start of sliceend- end of slice- Returns:
- slice from the input array
-
closeQuietly
Close a Closeable with no error thrown- Parameters:
cl- - Closeable (may be null)
-
closeQuietly
close a Socket with no error thrown- Parameters:
sock- - Socket (may be null)
-
closeQuietly
close a Socket with no error thrown- Parameters:
sock- - ServerSocket (may be null)
-
startsWith
public static boolean startsWith(byte[] target, byte[] search, int offset) Check if a byte array starts with the given byte array.- Parameters:
target- array to scansearch- array to search foroffset- starting offset (≥0)- Returns:
- true if the search array matches the target at the current offset
- See Also:
-
isXML
public static boolean isXML(byte[] target) Detects if some content starts with the standard XML prefix.- Parameters:
target- the content to check- Returns:
- true if the document starts with the standard XML prefix.
-
baToHexString
Convert binary byte array to hex string.- Parameters:
ba- input binary byte array- Returns:
- hex representation of binary input
-
baToHexString
Convert binary byte array to hex string.- Parameters:
ba- input binary byte arrayseparator- the separator to be added between pairs of hex digits- Returns:
- hex representation of binary input
-
baToHexBytes
public static byte[] baToHexBytes(byte[] ba) Convert binary byte array to hex string.- Parameters:
ba- input binary byte array- Returns:
- hex representation of binary input
-
read
Read as much as possible into buffer.- Parameters:
is- the stream to read frombuffer- output bufferoffset- offset into bufferlength- number of bytes to read- Returns:
- the number of bytes actually read
- Throws:
IOException- if some I/O errors occur
-
displayThreads
public static void displayThreads(boolean includeDaemons) 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.- Parameters:
includeDaemons- whether to include daemon threads or not.
-
nullifyIfEmptyTrimmed
Returnsnullif input is empty,nullor contains spaces only- Parameters:
input- String- Returns:
- trimmed input or
null
-
isBlank
Check that value is empty (""),nullor whitespace only.- Parameters:
value- Value- Returns:
trueif the String is not empty (""), notnulland not whitespace only.
-
write
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.- Parameters:
data- the buffer to be writtenoutput- the output stream to use- Throws:
IOException- if there is a problem writing the data
-
formatDuration
Returns duration formatted with format HH:mm:ss.- Parameters:
elapsedSec- long elapsed time in seconds- Returns:
- String formatted with format HH:mm:ss
-
canSafelyWriteToFolder
Check whether we can write to a folder. A folder can be written to if if does not contain any file or folder ThrowIllegalArgumentExceptionif folder cannot be written to either:- Because it exists but is not a folder
- Because it exists but is not empty
- Because it does not exist but cannot be created
- Parameters:
folder- to check- Throws:
IllegalArgumentException- when folder can't be written to
-
canSafelyWriteToFolder
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. ThrowIllegalArgumentExceptionif folder cannot be written to either:- Because it exists but is not a folder
- Because it exists but is not empty using folder.listFiles(exporterFileFilter)
- Because it does not exist but cannot be created
- Parameters:
folder- to checkfileFilter- used to filter listing of folder- Throws:
IllegalArgumentException- when folder can't be written to
-
canSafelyWriteToFolder
Check whether we can write to a folder. IfdeleteFolderContentistruethe folder or file with the same name will be emptied or deleted.- Parameters:
folder- to checkdeleteFolderContent- flag whether the folder should be emptied or a file with the same name deleted- Throws:
IllegalArgumentException- when folder can't be written to Throw IllegalArgumentException if folder cannot be written
-
canSafelyWriteToFolder
public static void canSafelyWriteToFolder(File folder, boolean deleteFolderIfExists, FileFilter exporterFileFilter) Check whether we can write to a folder.- Parameters:
folder- which should be checked for writability and emptinessdeleteFolderIfExists- flag whether the folder should be emptied or a file with the same name deletedexporterFileFilter- used for filtering listing of the folder- Throws:
IllegalArgumentException- when folder can't be written to. That could have the following reasons:- it exists but is not a folder
- it exists but is not empty
- it does not exist but cannot be created
-
replaceAllWithRegex
public static Object[] replaceAllWithRegex(String source, String regex, String replacement, boolean caseSensitive) Replace in source all matches of regex by replacement taking into account case if caseSensitive is true- Parameters:
source- Source textregex- Regular expressionreplacement- Replacement text to which function applies a quotingcaseSensitive- is case taken into account- Returns:
- array of Object where first row is the replaced text, second row is the number of replacement that occurred
-
replaceValue
public static int replaceValue(String regex, String replaceBy, boolean caseSensitive, String value, Consumer<? super String> setter) Replace all occurrences ofregexinvaluebyreplaceByifvalueis not blank. The replaced text is fed into thesetter.- Parameters:
regex- Regular expression that is used for the searchreplaceBy- value that is used for replacementcaseSensitive- flag whether the regex should be applied case sensitivevalue- in which the replacement takes placesetter- that gets called with the replaced value- Returns:
- number of matches that were replaced
-
unsplit
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.- Parameters:
splittee- Array of Objects to be concatenated.splitChar- Object to unsplit the strings with.- Returns:
- Array of all the tokens.
-
generateRandomAlphanumericPassword
Random alphanumeric password of a given length.- Parameters:
length- Max length of password- Returns:
- String random password
-