net.sf.kdgcommons.test

Class StringAsserts

java.lang.Object

net.sf.kdgcommons.test.StringAsserts

public class StringAsserts
extends Object

A collection of static methods for making JUnit assertions about strings.

If using JDK 1.5 or above, you can static import everything in this class, so that the calls look exactly like built-in JUnit assertions.

Constructor Summary

Constructors

Constructor and Description
StringAsserts()

Method Summary

Modifier and Type	Method and Description
static void	assertContainsRegex(String regex, String str) Asserts that the passed string contains a specified regular expression, showing expected/actual on failure.
static void	assertContainsRegex(String message, String regex, String str) Asserts that the passed string contains a specified regular expression, showing caller-defined failure message on failure.
static String	assertContainsThenRemove(String src, String expected) Asserts that a string is contained within another, and then removes it.
static void	assertDoesntContainRegex(String regex, String str) Asserts that the passed string does not contain a specified regular expression, showing expected/actual on failure.
static void	assertDoesntContainRegex(String message, String regex, String str) Asserts that the passed string does not contain a specified regular expresion, showing caller-defined failure message on failure.
static void	assertNotEmpty(String value) Asserts that the passed string is not empty or null.
static void	assertNotEmpty(String message, String value) Asserts that the passed string is not empty or null.
static void	assertRegex(String regex, String actual) Asserts that the passed string exactly matches a regular expression, showing expected/actual on failure.
static void	assertRegex(String message, String regex, String actual) Asserts that the passed string exactly matches a regular expression, showing caller-defined failure message on failure.
static void	assertSubstringCount(String str, String sub, int expected) Asserts that a given string contains N instances of a substring.
static void	assertSubstringCount(String message, String str, String sub, int expected) Asserts that a given string contains N instances of a substring, and outputs a specified message if the assertion fails.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringAsserts

public StringAsserts()

Method Detail

assertNotEmpty

public static void assertNotEmpty(String value)

Asserts that the passed string is not empty or null.

assertNotEmpty

public static void assertNotEmpty(String message,
                                  String value)

Asserts that the passed string is not empty or null. On failure, reports the specified message along with a descriptive error message.

assertSubstringCount

public static void assertSubstringCount(String str,
                                        String sub,
                                        int expected)

Asserts that a given string contains N instances of a substring.

Parameters:

str - The source string.

sub - The substring to search for.

expected - The number of times that the substring should appear in the source string.

assertSubstringCount

public static void assertSubstringCount(String message,
                                        String str,
                                        String sub,
                                        int expected)

Asserts that a given string contains N instances of a substring, and outputs a specified message if the assertion fails.

Parameters:

message - The message to output if assertion fails -- note that the "expected versus actual" message will be appended to this.

str - The source string.

sub - The substring to search for.

expected - The number of times that the substring should appear in the source string.

assertRegex

public static void assertRegex(String regex,
                               String actual)

Asserts that the passed string exactly matches a regular expression, showing expected/actual on failure.

assertRegex

public static void assertRegex(String message,
                               String regex,
                               String actual)

Asserts that the passed string exactly matches a regular expression, showing caller-defined failure message on failure.

assertContainsRegex

public static void assertContainsRegex(String regex,
                                       String str)

Asserts that the passed string contains a specified regular expression, showing expected/actual on failure.

assertContainsRegex

public static void assertContainsRegex(String message,
                                       String regex,
                                       String str)

Asserts that the passed string contains a specified regular expression, showing caller-defined failure message on failure.

assertDoesntContainRegex

public static void assertDoesntContainRegex(String regex,
                                            String str)

Asserts that the passed string does not contain a specified regular expression, showing expected/actual on failure.

assertDoesntContainRegex

public static void assertDoesntContainRegex(String message,
                                            String regex,
                                            String str)

Asserts that the passed string does not contain a specified regular expresion, showing caller-defined failure message on failure.

assertContainsThenRemove

public static String assertContainsThenRemove(String src,
                                              String expected)

Asserts that a string is contained within another, and then removes it. This is useful for testing output when you know the expected content, but do not know the order it appears in.

Parameters:

src - The source string.

expected - The text expected in that string.

Returns:

The source string, with the first occurrence of the expected text removed.