Class StringSubject

java.lang.Object

com.google.common.truth.Subject

com.google.common.truth.ComparableSubject<String>

com.google.common.truth.StringSubject

public class StringSubject
extends ComparableSubject<String>

A subject for String values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StringSubject.CaseInsensitiveStringComparison	Offers case-insensitive checks for string values.

Nested classes/interfaces inherited from class Subject

Subject.Factory<SubjectT,ActualT>

Modifier and Type	Class	Description
static interface	Subject.Factory<SubjectT extends Subject, ActualT>	In a fluent assertion chain, the argument to the common overload of about, the method that specifies what kind of Subject to create.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StringSubject(FailureMetadata metadata, @Nullable String actual)	The constructor is for use by subclasses only.

Method Summary

Modifier and Type	Method	Description
void	contains(@Nullable CharSequence string)	Checks that the actual value contains the given sequence.
void	containsMatch(@Nullable String regex)	Checks that the actual value contains a match on the given regex.
void	containsMatch(@Nullable Pattern regex)	Checks that the actual value contains a match on the given regex.
void	doesNotContain(@Nullable CharSequence string)	Checks that the actual value does not contain the given sequence.
void	doesNotContainMatch(@Nullable String regex)	Checks that the actual value does not contain a match on the given regex.
void	doesNotContainMatch(@Nullable Pattern regex)	Checks that the actual value does not contain a match on the given regex.
void	doesNotMatch(@Nullable String regex)	Checks that the actual value does not match the given regex.
void	doesNotMatch(@Nullable Pattern regex)	Checks that the actual value does not match the given regex.
void	endsWith(@Nullable String string)	Checks that the actual value ends with the given string.
void	hasLength(int length)	Checks that the actual value has the given length.
StringSubject.CaseInsensitiveStringComparison	ignoringCase()	Returns a StringSubject-like instance that will ignore the case of the characters.
void	isEmpty()	Checks that the actual value is the empty string.
final void	isEquivalentAccordingToCompareTo(@Nullable String expected)	Deprecated. Use Subject.isEqualTo(Object) instead.
void	isNotEmpty()	Checks that the actual value is not the empty string.
void	matches(@Nullable String regex)	Checks that the actual value matches the given regex.
void	matches(@Nullable Pattern regex)	Checks that the actual value matches the given regex.
void	startsWith(@Nullable String string)	Checks that the actual value starts with the given string.

Methods inherited from class ComparableSubject

isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

Modifier and Type	Method	Description
final void	isAtLeast(String other)	Checks that the actual value is greater than or equal to other.
final void	isAtMost(String other)	Checks that the actual value is less than or equal to other.
final void	isGreaterThan(String other)	Checks that the actual value is greater than other.
final void	isIn(@Nullable Range<String> range)	Checks that the actual value is in range.
final void	isLessThan(String other)	Checks that the actual value is less than other.
final void	isNotIn(@Nullable Range<String> range)	Checks that the actual value is not in range.

Methods inherited from class Subject

actualCustomStringRepresentation, check, equals, failWithActual, failWithActual, failWithoutActual, hashCode, ignoreCheck, isAnyOf, isEqualTo, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameInstanceAs, isNull, isSameInstanceAs, toString

Modifier and Type	Method	Description
protected String	actualCustomStringRepresentation()	Returns a string representation of the actual value for inclusion in failure messages.
protected final StandardSubjectBuilder	check(String format, @Nullable Object... args)	Returns a builder for creating a derived subject.
final boolean	equals(@Nullable Object other)	Deprecated. Object.equals(Object) is not supported on Truth subjects.
protected final void	failWithActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, followed by an automatically added fact of the form: but was: actual value.
protected final void	failWithActual(String key, @Nullable Object value)	Fails, reporting a message with two "facts": key: value but was: actual value.
protected final void	failWithoutActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, without automatically adding the actual value.
final int	hashCode()	Deprecated. Object.hashCode() is not supported on Truth subjects.
protected final StandardSubjectBuilder	ignoreCheck()	Begins a new call chain that ignores any failures.
void	isAnyOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is equal to any of the given elements.
void	isEqualTo(@Nullable Object expected)	Checks that the value under test is equal to the given object.
void	isIn(@Nullable Iterable<?> iterable)	Checks that the value under test is equal to any element in the given iterable.
void	isInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is an instance of the given class.
void	isNoneOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is not equal to any of the given elements.
void	isNotEqualTo(@Nullable Object other)	Checks that the value under test is not equal to the given object.
void	isNotIn(@Nullable Iterable<?> iterable)	Checks that the value under test is not equal to any element in the given iterable.
void	isNotInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is not an instance of the given class.
void	isNotNull()	Checks that the value under test is not null.
final void	isNotSameInstanceAs(@Nullable Object other)	Checks that the value under test is not the same instance as the given object.
void	isNull()	Checks that the value under test is null.
final void	isSameInstanceAs(@Nullable Object expected)	Checks that the value under test is the same instance as the given object.
String	toString()	Deprecated. Object.toString() is not supported on Truth subjects.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StringSubject

protected StringSubject(FailureMetadata metadata,
 @Nullable String actual)

The constructor is for use by subclasses only. If you want to create an instance of this class itself, call check(...).that(actual).

Method Details

isEquivalentAccordingToCompareTo

@Deprecated
public final void isEquivalentAccordingToCompareTo(@Nullable String expected)

Deprecated.

Use Subject.isEqualTo(Object) instead. String comparison is consistent with equality.

Description copied from class: ComparableSubject

Checks that the actual value is equivalent to other according to Comparable.compareTo(T), (i.e., checks that a.comparesTo(b) == 0).

Note: Do not use this method for checking object equality. Instead, use Subject.isEqualTo(Object).

Overrides:

isEquivalentAccordingToCompareTo in class ComparableSubject<String>

hasLength

public void hasLength(int length)

Checks that the actual value has the given length.

isEmpty

public void isEmpty()

Checks that the actual value is the empty string.

isNotEmpty

public void isNotEmpty()

Checks that the actual value is not the empty string.

contains

public void contains(@Nullable CharSequence string)

Checks that the actual value contains the given sequence.

doesNotContain

public void doesNotContain(@Nullable CharSequence string)

Checks that the actual value does not contain the given sequence.

startsWith

public void startsWith(@Nullable String string)

Checks that the actual value starts with the given string.

endsWith

public void endsWith(@Nullable String string)

Checks that the actual value ends with the given string.

matches

public void matches(@Nullable String regex)

Checks that the actual value matches the given regex.

matches

@GwtIncompatible("java.util.regex.Pattern")
public void matches(@Nullable Pattern regex)

Checks that the actual value matches the given regex.

doesNotMatch

public void doesNotMatch(@Nullable String regex)

Checks that the actual value does not match the given regex.

doesNotMatch

@GwtIncompatible("java.util.regex.Pattern")
public void doesNotMatch(@Nullable Pattern regex)

Checks that the actual value does not match the given regex.

containsMatch

@GwtIncompatible("java.util.regex.Pattern")
public void containsMatch(@Nullable Pattern regex)

Checks that the actual value contains a match on the given regex.

containsMatch

public void containsMatch(@Nullable String regex)

Checks that the actual value contains a match on the given regex.

doesNotContainMatch

@GwtIncompatible("java.util.regex.Pattern")
public void doesNotContainMatch(@Nullable Pattern regex)

Checks that the actual value does not contain a match on the given regex.

doesNotContainMatch

public void doesNotContainMatch(@Nullable String regex)

Checks that the actual value does not contain a match on the given regex.

ignoringCase

public StringSubject.CaseInsensitiveStringComparison ignoringCase()

Returns a StringSubject-like instance that will ignore the case of the characters.

Character equality ignoring case is defined as follows: Characters must be equal either after calling Character.toLowerCase(char) or after calling Character.toUpperCase(char). Note that this is independent of any locale.