public final class Utils
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
private static class |
Utils.StackTraceType |
Modifier and Type | Field and Description |
---|---|
static char |
CHAR_REPLACEMENT |
private static java.util.Map<java.lang.Character,java.lang.String> |
ESCAPES |
private static java.lang.String |
FORMAT |
private static java.lang.String |
LINE_SEP |
private static Logger |
LOG |
private static char[] |
SPECIAL_CHARACTERS |
static char |
UNICODE_REPLACEMENT |
Modifier | Constructor and Description |
---|---|
private |
Utils()
Hide constructor for utility class.
|
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
annotationFormFor(ITestNGMethod method)
Given a TestNG method, returns the corresponding annotation based on the method type
|
static java.lang.String |
arrayToString(java.lang.String[] strings) |
private static java.lang.String |
buildStackTrace(java.lang.Throwable t,
boolean toHtml,
Utils.StackTraceType type) |
static void |
checkInstanceOrStatic(java.lang.Object instance,
java.lang.reflect.Method method)
Make sure that either we have an instance or if not, that the method is static
|
static void |
checkReturnType(java.lang.reflect.Method method,
java.lang.Class<?>... returnTypes) |
static java.lang.String |
defaultIfStringEmpty(java.lang.String s,
java.lang.String defaultValue) |
static java.lang.String |
detailedMethodName(ITestNGMethod method,
boolean fqn) |
static void |
error(java.lang.String errorMessage) |
static java.lang.String |
escapeHtml(java.lang.String s) |
static java.lang.String |
escapeUnicode(java.lang.String s) |
(package private) static java.lang.String |
filterTrace(java.lang.String trace) |
static boolean |
isStringBlank(java.lang.String s) |
static boolean |
isStringEmpty(java.lang.String s) |
static boolean |
isStringNotBlank(java.lang.String s) |
static boolean |
isStringNotEmpty(java.lang.String s) |
private static boolean |
isTooVerbose() |
static <T> java.lang.String |
join(java.util.List<T> objects,
java.lang.String separator) |
static void |
log(java.lang.String msg) |
static void |
log(java.lang.String cls,
int level,
java.lang.String msg)
Logs the the message to System.out if level is greater than or equal to
TestRunner.getVerbose().
|
static java.lang.String |
longStackTrace(java.lang.Throwable t,
boolean toHtml)
Helper that returns a short stack trace.
|
private static java.io.BufferedWriter |
openWriter(java.io.File outputFile,
java.lang.String encoding) |
static java.io.BufferedWriter |
openWriter(java.lang.String outputDir,
java.lang.String fileNameParameter)
Open a BufferedWriter for the specified file.
|
static java.lang.String |
replaceSpecialCharacters(java.lang.String fileNameParameter)
If the file name contains special characters like *,/,\ and so on, exception will be thrown and
report file will not be created.
Special characters are platform specific and they are not same for example on Windows and Macintosh. |
static java.lang.String |
shortStackTrace(java.lang.Throwable t,
boolean toHtml)
Helper that returns a long stack trace.
|
static java.lang.String[] |
split(java.lang.String string,
java.lang.String sep)
Tokenize the string using the separator.
|
private static java.lang.String |
toString(java.lang.Class<?>[] classes) |
static java.lang.String |
toString(java.lang.Object obj)
Returns the string representation of the specified object, transparently handling null
references and arrays.
|
static java.lang.String |
toString(java.lang.Object object,
java.lang.Class<?> objectClass) |
private static void |
writeFile(java.io.File outputFile,
java.lang.String sb,
java.lang.String encoding) |
private static void |
writeFile(java.io.File outputFolder,
java.lang.String fileNameParameter,
java.lang.String sb,
java.lang.String encoding)
Writes the content of the sb string to the file named filename in outDir.
|
static void |
writeFile(java.lang.String outputDir,
java.lang.String fileName,
java.lang.String sb)
Writes the content of the sb string to the file named filename in outDir.
|
static void |
writeResourceToFile(java.io.File file,
java.lang.String resourceName,
java.lang.Class<?> clasz) |
static void |
writeUtf8File(java.lang.String outputDir,
java.lang.String fileName,
java.lang.String sb)
Writes the content of the sb string to the file named filename in outDir encoding the output as
UTF-8.
|
static void |
writeUtf8File(java.lang.String outputDir,
java.lang.String fileName,
XMLStringBuffer xsb,
java.lang.String prefix) |
private static final java.lang.String LINE_SEP
private static final char[] SPECIAL_CHARACTERS
public static final char CHAR_REPLACEMENT
public static final char UNICODE_REPLACEMENT
private static final java.lang.String FORMAT
private static final Logger LOG
private static final java.util.Map<java.lang.Character,java.lang.String> ESCAPES
public static void writeUtf8File(@Nullable java.lang.String outputDir, java.lang.String fileName, XMLStringBuffer xsb, java.lang.String prefix)
public static void writeUtf8File(@Nullable java.lang.String outputDir, java.lang.String fileName, java.lang.String sb)
outputDir
- the output directory (may not exist). If null then current directory
is used.fileName
- the filenamesb
- the file contentpublic static void writeFile(@Nullable java.lang.String outputDir, java.lang.String fileName, java.lang.String sb)
outputDir
- the output directory (may not exist). If null then current directory
is used.fileName
- the filenamesb
- the file contentprivate static void writeFile(@Nullable java.io.File outputFolder, java.lang.String fileNameParameter, java.lang.String sb, @Nullable java.lang.String encoding)
outputFolder
- the output directory (may not exist). If null then current
directory is used.fileNameParameter
- the filenamesb
- the file contentprivate static void writeFile(java.io.File outputFile, java.lang.String sb, @Nullable java.lang.String encoding)
public static java.io.BufferedWriter openWriter(@Nullable java.lang.String outputDir, java.lang.String fileNameParameter) throws java.io.IOException
outputDir
- output directory. If null, then current directory is usedfileNameParameter
- file namejava.io.IOException
- if anything goes wrong while creating files.private static java.io.BufferedWriter openWriter(java.io.File outputFile, @Nullable java.lang.String encoding) throws java.io.IOException
java.io.IOException
public static void log(java.lang.String msg)
public static void log(java.lang.String cls, int level, java.lang.String msg)
"[cls] msg"
cls
- the class name to prefix the log message.level
- the logging level of the message.msg
- the message to log to System.out.public static void error(java.lang.String errorMessage)
public static java.lang.String[] split(java.lang.String string, java.lang.String sep)
public static void writeResourceToFile(java.io.File file, java.lang.String resourceName, java.lang.Class<?> clasz) throws java.io.IOException
java.io.IOException
public static java.lang.String defaultIfStringEmpty(java.lang.String s, java.lang.String defaultValue)
public static boolean isStringBlank(java.lang.String s)
public static boolean isStringEmpty(java.lang.String s)
public static boolean isStringNotBlank(java.lang.String s)
public static boolean isStringNotEmpty(java.lang.String s)
public static java.lang.String longStackTrace(java.lang.Throwable t, boolean toHtml)
t
- - The Throwable
exceptiontoHtml
- - true
if the stacktrace should be translated to html as wellpublic static java.lang.String shortStackTrace(java.lang.Throwable t, boolean toHtml)
t
- - The Throwable
exceptiontoHtml
- - true
if the stacktrace should be translated to html as wellprivate static java.lang.String buildStackTrace(java.lang.Throwable t, boolean toHtml, Utils.StackTraceType type)
private static boolean isTooVerbose()
public static java.lang.String escapeHtml(java.lang.String s)
public static java.lang.String escapeUnicode(java.lang.String s)
static java.lang.String filterTrace(java.lang.String trace)
public static java.lang.String toString(java.lang.Object object, java.lang.Class<?> objectClass)
public static java.lang.String detailedMethodName(ITestNGMethod method, boolean fqn)
public static java.lang.String annotationFormFor(ITestNGMethod method)
method
- - An ITestNGMethod
object.public static java.lang.String arrayToString(java.lang.String[] strings)
public static java.lang.String replaceSpecialCharacters(java.lang.String fileNameParameter)
fileNameParameter
- file name that could contain special characters.public static <T> java.lang.String join(java.util.List<T> objects, java.lang.String separator)
public static void checkInstanceOrStatic(java.lang.Object instance, java.lang.reflect.Method method)
public static void checkReturnType(java.lang.reflect.Method method, java.lang.Class<?>... returnTypes)
private static java.lang.String toString(java.lang.Class<?>[] classes)
public static java.lang.String toString(java.lang.Object obj)
obj
- the object