testng 7.10.2 · org.testng.internal.Utils

Modifier and Type	Class and Description
private static enum	Utils.StackTraceType

Modifier and Type	Field and Description
public static final char	CHAR_REPLACEMENT
private static final Map<Character, String>	ESCAPES
private static final String	FORMAT
private static final String	LINE_SEP
private static final Logger	LOG
private static int	m_verbose
private static final char[]	SPECIAL_CHARACTERS
public static final char	UNICODE_REPLACEMENT

Access	Constructor and Description
private	Utils() Hide constructor for utility class.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: - A String representation of the corresponding annotation. annotationFormFor(ITestNGMethod - An `ITestNGMethod` object. method) Given a TestNG method, returns the corresponding annotation based on the method type
public static String	arrayToString(String[] strings)
private static String	buildStackTrace(Throwable t, boolean toHtml, Utils.StackTraceType type)
public static void	checkInstanceOrStatic(Object instance, Method method)
public static void	checkReturnType(Method method, Class<?>... returnTypes)
public static String	defaultIfStringEmpty(String s, String defaultValue)
public static String	detailedMethodName(ITestNGMethod method, boolean fqn)
public static String	detailedMethodName(ITestNGMethod method)
public static void	error(String errorMessage)
public static String	escapeHtml(String s)
public static String	escapeUnicode(String s)
pack-priv static String	filterTrace(String trace)
public static int	getVerbose()
public static boolean	isStringBlank(String s)
public static boolean	isStringEmpty(String s)
public static boolean	isStringNotBlank(String s)
public static boolean	isStringNotEmpty(String s)
private static boolean	isTooVerbose()
public static <T> String	join(List<T> objects, String separator)
public static void	log(String msg)
public static void	log(String the class name to prefix the log message. cls, int the logging level of the message. level, String the message to log to System.out. msg) Logs the the message to System.out if level is greater than or equal to getVerbose().
public static String	Returns: - A string that represents the short stack trace. longStackTrace(Throwable - The `Throwable` exception t, boolean - `true` if the stacktrace should be translated to html as well toHtml) Helper that returns a short stack trace.
public static BufferedWriter	openWriter(String output directory. If `null`, then current directory is used outputDir, String file name fileNameParameter) Open a BufferedWriter for the specified file.
private static BufferedWriter	openWriter(File outputFile, String encoding)
public static String	Returns: fileName with special characters replaced replaceSpecialCharacters(String file name that could contain special characters. fileNameParameter) If the file name contains special characters like *,/,\ and so on, exception will be thrown and report file will not be created.
public static void	setVerbose(int n)
public static String	Returns: - A string that represents the full stack trace. shortStackTrace(Throwable - The `Throwable` exception t, boolean - `true` if the stacktrace should be translated to html as well toHtml) Helper that returns a long stack trace.
public static String[]	split(String string, String sep)
public static String	stringifyTypes(Class<?>[] parameterTypes)
public static String	toString(Object object, Class<?> objectClass)
private static String	toString(Class<?>[] classes)
public static String	Returns: the string representation toString(Object the object obj) Returns the string representation of the specified object, transparently handling null references and arrays.
public static void	warn(String warnMsg)
public static void	writeFile(String the output directory (may not exist). If `null` then current directory is used. outputDir, String the filename fileName, String the file content sb) Writes the content of the sb string to the file named filename in outDir.
private static void	writeFile(File the output directory (may not exist). If `null` then current directory is used. outputFolder, String the filename fileNameParameter, String the file content sb, String encoding) Writes the content of the sb string to the file named filename in outDir.
private static void	writeFile(File outputFile, String sb, String encoding)
public static void	writeResourceToFile(File file, String resourceName, Class<?> clasz)
public static void	writeUtf8File(String outputDir, String fileName, XMLStringBuffer xsb, String prefix)
public static void	writeUtf8File(String the output directory (may not exist). If `null` then current directory is used. outputDir, String the filename fileName, String the file content sb) Writes the content of the sb string to the file named filename in outDir encoding the output as UTF-8.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CHAR_REPLACEMENT	back to summary
public static final char CHAR_REPLACEMENT

ESCAPES	back to summary
private static final Map<Character, String> ESCAPES

FORMAT	back to summary
private static final String FORMAT

LINE_SEP	back to summary
private static final String LINE_SEP

LOG	back to summary
private static final Logger LOG

m_verbose	back to summary
private static int m_verbose

SPECIAL_CHARACTERS	back to summary
private static final char[] SPECIAL_CHARACTERS

UNICODE_REPLACEMENT	back to summary
public static final char UNICODE_REPLACEMENT

Utils	back to summary
private Utils() Hide constructor for utility class.

Method Detail

annotationFormFor back to summary

annotationFormFor	back to summary
public static String annotationFormFor(ITestNGMethod method) Given a TestNG method, returns the corresponding annotation based on the method type Parameters method:ITestNGMethod - An `ITestNGMethod` object. Returns:String - A String representation of the corresponding annotation.

public static String annotationFormFor(ITestNGMethod method)

Given a TestNG method, returns the corresponding annotation based on the method type

Parameters

method:ITestNGMethod: - An ITestNGMethod object.

Returns:String

- A String representation of the corresponding annotation.

arrayToString	back to summary
public static String arrayToString(String[] strings)

buildStackTrace	back to summary
private static String buildStackTrace(Throwable t, boolean toHtml, Utils.StackTraceType type)

checkInstanceOrStatic	back to summary
public static void checkInstanceOrStatic(Object instance, Method method)

checkReturnType	back to summary
public static void checkReturnType(Method method, Class<?>... returnTypes)

defaultIfStringEmpty	back to summary
public static String defaultIfStringEmpty(String s, String defaultValue)

detailedMethodName	back to summary
public static String detailedMethodName(ITestNGMethod method, boolean fqn)

detailedMethodName	back to summary
public static String detailedMethodName(ITestNGMethod method)

error	back to summary
public static void error(String errorMessage)

escapeHtml	back to summary
public static String escapeHtml(String s)

escapeUnicode	back to summary
public static String escapeUnicode(String s)

filterTrace	back to summary
pack-priv static String filterTrace(String trace)

getVerbose	back to summary
public static int getVerbose()

isStringBlank	back to summary
public static boolean isStringBlank(String s)

isStringEmpty	back to summary
public static boolean isStringEmpty(String s)

isStringNotBlank	back to summary
public static boolean isStringNotBlank(String s)

isStringNotEmpty	back to summary
public static boolean isStringNotEmpty(String s)

isTooVerbose	back to summary
private static boolean isTooVerbose()

join	back to summary
public static <T> String join(List<T> objects, String separator)

log	back to summary
public static void log(String msg)

log	back to summary
public static void log(String cls, int level, String msg) Logs the the message to System.out if level is greater than or equal to getVerbose(). The message is logged as: "[cls] msg" Parameters cls:String the class name to prefix the log message. level:int the logging level of the message. msg:String the message to log to System.out.

log

back to summary

public static void log(String cls, int level, String msg)

Logs the the message to System.out if level is greater than or equal to getVerbose(). The message is logged as:

    "[cls] msg"

Parameters

cls:String: the class name to prefix the log message.
level:int: the logging level of the message.
msg:String: the message to log to System.out.

longStackTrace back to summary

longStackTrace	back to summary
public static String longStackTrace(Throwable t, boolean toHtml) Helper that returns a short stack trace. Parameters t:Throwable - The `Throwable` exception toHtml:boolean - `true` if the stacktrace should be translated to html as well Returns:String - A string that represents the short stack trace.

public static String longStackTrace(Throwable t, boolean toHtml)

Helper that returns a short stack trace.

Parameters

t:Throwable: - The Throwable exception
toHtml:boolean: - true if the stacktrace should be translated to html as well

Returns:String

- A string that represents the short stack trace.

openWriter back to summary

openWriter	back to summary
public static BufferedWriter openWriter(String outputDir, String fileNameParameter) throws IOException Open a BufferedWriter for the specified file. If output directory doesn't exist, it is created. If the output file exists, it is deleted. The output file is created in any case. Parameters outputDir:String output directory. If `null`, then current directory is used fileNameParameter:String file name Exceptions IOException: if anything goes wrong while creating files.

public static BufferedWriter openWriter(String outputDir, String fileNameParameter) throws IOException

Open a BufferedWriter for the specified file. If output directory doesn't exist, it is created. If the output file exists, it is deleted. The output file is created in any case.

Parameters

outputDir:String: output directory. If null, then current directory is used
fileNameParameter:String: file name

Exceptions

IOException:: if anything goes wrong while creating files.

openWriter	back to summary
private static BufferedWriter openWriter(File outputFile, String encoding) throws IOException

replaceSpecialCharacters	back to summary
public static String replaceSpecialCharacters(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. is not allowed on Windows, but it is on Macintosh. In order to have the same behavior of testng on the all platforms, characters like * will be replaced on all platforms whether they are causing the problem or not. Parameters fileNameParameter:String file name that could contain special characters. Returns:String fileName with special characters replaced

replaceSpecialCharacters

back to summary

public static String replaceSpecialCharacters(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. * is not allowed on Windows, but it is on Macintosh.
In order to have the same behavior of testng on the all platforms, characters like * will be replaced on all platforms whether they are causing the problem or not.

Parameters

fileNameParameter:String: file name that could contain special characters.

Returns:String

fileName with special characters replaced

setVerbose	back to summary
public static void setVerbose(int n)

shortStackTrace back to summary

shortStackTrace	back to summary
public static String shortStackTrace(Throwable t, boolean toHtml) Helper that returns a long stack trace. Parameters t:Throwable - The `Throwable` exception toHtml:boolean - `true` if the stacktrace should be translated to html as well Returns:String - A string that represents the full stack trace.

public static String shortStackTrace(Throwable t, boolean toHtml)

Helper that returns a long stack trace.

Parameters

t:Throwable: - The Throwable exception
toHtml:boolean: - true if the stacktrace should be translated to html as well

Returns:String

- A string that represents the full stack trace.

split	back to summary
public static String[] split(String string, String sep)

stringifyTypes	back to summary
public static String stringifyTypes(Class<?>[] parameterTypes)

toString	back to summary
public static String toString(Object object, Class<?> objectClass)

toString	back to summary
private static String toString(Class<?>[] classes)

toString	back to summary
public static String toString(Object obj) Returns the string representation of the specified object, transparently handling null references and arrays. Parameters obj:Object the object Returns:String the string representation

toString

back to summary

public static String toString(Object obj)

Returns the string representation of the specified object, transparently handling null references and arrays.

Parameters

obj:Object: the object

Returns:String

the string representation

warn	back to summary
public static void warn(String warnMsg)

writeFile back to summary

writeFile	back to summary
public static void writeFile(String outputDir, String fileName, String sb) Writes the content of the sb string to the file named filename in outDir. If outDir does not exist, it is created. Parameters outputDir:String the output directory (may not exist). If `null` then current directory is used. fileName:String the filename sb:String the file content

public static void writeFile(String outputDir, String fileName, String sb)

Writes the content of the sb string to the file named filename in outDir. If outDir does not exist, it is created.

Parameters

outputDir:String: the output directory (may not exist). If null then current directory is used.
fileName:String: the filename
sb:String: the file content

writeFile back to summary

writeFile	back to summary
private static void writeFile(File outputFolder, String fileNameParameter, String sb, String encoding) Writes the content of the sb string to the file named filename in outDir. If outDir does not exist, it is created. Parameters outputFolder:File the output directory (may not exist). If `null` then current directory is used. fileNameParameter:String the filename sb:String the file content

private static void writeFile(File outputFolder, String fileNameParameter, String sb, String encoding)

Writes the content of the sb string to the file named filename in outDir. If outDir does not exist, it is created.

Parameters

outputFolder:File: the output directory (may not exist). If null then current directory is used.
fileNameParameter:String: the filename
sb:String: the file content

writeFile	back to summary
private static void writeFile(File outputFile, String sb, String encoding)

writeResourceToFile	back to summary
public static void writeResourceToFile(File file, String resourceName, Class<?> clasz) throws IOException

writeUtf8File	back to summary
public static void writeUtf8File(String outputDir, String fileName, XMLStringBuffer xsb, String prefix)

writeUtf8File back to summary

public static void writeUtf8File(String outputDir, String fileName, String sb)

Writes the content of the sb string to the file named filename in outDir encoding the output as UTF-8. If outDir does not exist, it is created.

Parameters

outputDir:String: the output directory (may not exist). If null then current directory is used.
fileName:String: the filename
sb:String: the file content

Modifier and Type	Field and Description
public static final Utils.StackTraceType	FULL
public static final Utils.StackTraceType	SHORT

Modifier and Type	Method and Description
public static Utils.StackTraceType	valueOf(String name)
public static Utils.StackTraceType[]	values()

public final Class Utils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum Utils.StackTraceType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail