Package com.google.common.truth

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 class	StringSubject.CaseInsensitiveStringComparison	Offers case-insensitive checks for string values.

Nested classes/interfaces inherited from class com.google.common.truth.Subject

Subject.Factory<SubjectT extends Subject,ActualT>

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.
void	isEquivalentAccordingToCompareTo(@Nullable String expected)	Deprecated. Use Subject.isEqualTo(java.lang.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 com.google.common.truth.ComparableSubject

isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

Methods inherited from class com.google.common.truth.Subject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

isEquivalentAccordingToCompareTo

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

Deprecated.

Use Subject.isEqualTo(java.lang.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.