com.aaronicsubstances.code.augmentor.core.util

Class TaskUtils

java.lang.Object

com.aaronicsubstances.code.augmentor.core.util.TaskUtils

public class TaskUtils
extends java.lang.Object

Exposes helper methods for generic tasks

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	NEW_LINE_REGEX

Constructor Summary

Constructors

Constructor and Description
TaskUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	calcHash(java.lang.String contents, java.nio.charset.Charset charset) Calculate MD5 hash of file
static int	calculateLineNumber(java.lang.String content, int position) Calculates line number given a position in a string.
static void	copyFile(java.io.File srcFile, java.io.File destFile)
static void	deleteDir(java.io.File dir) Deletes a directory recursively.
static boolean	isBlank(java.lang.String s) Determines whether a string is null, has no characters, or has only whitespace characters.
static boolean	isEmpty(java.lang.String s) Determines whether a string is null or has no characters.
static boolean	isNewLine(char ch) Determines whether a character is a newline character.
static void	logInfo(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender, java.lang.String format, java.lang.Object... args)
static void	logVerbose(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender, java.lang.String format, java.lang.Object... args)
static void	logWarn(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender, java.lang.String format, java.lang.Object... args)
static java.lang.String	modifyNameToBeAbsent(java.util.Collection<java.lang.String> names, java.lang.String originalName) Generates a name with a given prefix which is guaranteed to be absent in a given list.
static java.lang.String	readFile(java.io.File srcFile, java.nio.charset.Charset charset)
static java.lang.String	serializeException(java.lang.Throwable e)
static java.util.List<java.lang.String>	splitIntoLines(java.lang.String text, boolean separateTerminators) Splits a string into lines.
static java.lang.String	strMultiply(java.lang.String s, int nTimes) Returns a string consisting of a concatenation of its duplicates by a given number of times.
static java.lang.String	validateJson(java.lang.String s) Determines whether a string is a valid JSON string.
static void	writeFile(java.io.File destFile, java.nio.charset.Charset charset, java.lang.String contents)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NEW_LINE_REGEX

public static final java.util.regex.Pattern NEW_LINE_REGEX

Constructor Detail

TaskUtils

public TaskUtils()

Method Detail

splitIntoLines

public static java.util.List<java.lang.String> splitIntoLines(java.lang.String text,
                                                              boolean separateTerminators)

Splits a string into lines. The list of lines can either be without line terminators, alternating in pairs with their line terminators. If text doesn't end with a new line, then the last item is null.

Alternatively lines can have their terminators as suffixes, in which the size of return value will the same as the number of lines in text.

Parameters:

text - string to split.

separateTerminators - false to have lines include their terminators; true to add line terminator as separate item in collection result

Returns:

list of lines and terminators, with terminators included or excluded from lines as determined by separateTerminators parameter.

calculateLineNumber

public static int calculateLineNumber(java.lang.String content,
                                      int position)

Calculates line number given a position in a string.

Parameters:

content - source code text.

position - position in s.

Returns:

line number.

isNewLine

public static boolean isNewLine(char ch)

Determines whether a character is a newline character.

Parameters:

ch - character to test

Returns:

true or false if ch is a newline character or not respectively.

isEmpty

public static boolean isEmpty(java.lang.String s)

Determines whether a string is null or has no characters.

Parameters:

s - string to test

Returns:

true only if s is null/empty

isBlank

public static boolean isBlank(java.lang.String s)

Determines whether a string is null, has no characters, or has only whitespace characters.

Parameters:

s - string to test

Returns:

true only if s is null/empty/whitespace only.

strMultiply

public static java.lang.String strMultiply(java.lang.String s,
                                           int nTimes)

Returns a string consisting of a concatenation of its duplicates by a given number of times.

Parameters:

s - string to duplicate

nTimes - duplication count

Returns:

multiplied string

validateJson

public static java.lang.String validateJson(java.lang.String s)

Determines whether a string is a valid JSON string.

Parameters:

s - string to validate.

Returns:

error message or null if s is valid JSON.

modifyNameToBeAbsent

public static java.lang.String modifyNameToBeAbsent(java.util.Collection<java.lang.String> names,
                                                    java.lang.String originalName)

Generates a name with a given prefix which is guaranteed to be absent in a given list. If prefix is not in the list in the first place, then prefix is simply returned.

Parameters:

names - given list.

originalName - given prefix.

Returns:

a name which has originalName as a prefix and is not in names list.

calcHash

public static java.lang.String calcHash(java.lang.String contents,
                                        java.nio.charset.Charset charset)
                                 throws java.lang.Exception

Calculate MD5 hash of file

Parameters:

contents - file contents

charset - file encoding

Returns:

MD5 hash of file as hexadecimal (lowercase) string.

Throws:

java.lang.Exception

readFile

public static java.lang.String readFile(java.io.File srcFile,
                                        java.nio.charset.Charset charset)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeFile

public static void writeFile(java.io.File destFile,
                             java.nio.charset.Charset charset,
                             java.lang.String contents)
                      throws java.io.IOException

Throws:

java.io.IOException

copyFile

public static void copyFile(java.io.File srcFile,
                            java.io.File destFile)
                     throws java.io.IOException

Throws:

java.io.IOException

deleteDir

public static void deleteDir(java.io.File dir)

Deletes a directory recursively. Silently ignores any deletion failures.

Parameters:

dir - directory to delete.

logVerbose

public static void logVerbose(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender,
                              java.lang.String format,
                              java.lang.Object... args)

logInfo

public static void logInfo(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender,
                           java.lang.String format,
                           java.lang.Object... args)

logWarn

public static void logWarn(java.util.function.BiConsumer<GenericTaskLogLevel,java.util.function.Supplier<java.lang.String>> logAppender,
                           java.lang.String format,
                           java.lang.Object... args)

serializeException

public static java.lang.String serializeException(java.lang.Throwable e)