com.google.common.truth

Class StringSubject

java.lang.Object

com.google.common.truth.Subject<S,T>

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

com.google.common.truth.StringSubject

public class StringSubject
extends ComparableSubject<StringSubject,String>

Propositions for string subjects.

Author:

David Saff, Christian Gruber (cgruber@israfil.net)

Nested Class Summary

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

Subject.Factory<SubjectT extends Subject<SubjectT,ActualT>,ActualT>

Field Summary

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

failureStrategy

Constructor Summary

Constructors

Constructor and Description
StringSubject(FailureMetadata metadata, String string)
StringSubject(FailureStrategy failureStrategy, String string) Deprecated. Switch your Subject from accepting FailureStrategy (and exposing a SubjectFactory) to accepting a FailureMetadata (and exposing a Subject.Factory), at which point you'll call the FailureMetadata overload of this constructor instead.

Method Summary

Modifier and Type	Method and Description
protected String	actualCustomStringRepresentation() Supplies the direct string representation of the actual value to other methods which may prefix or otherwise position it in an error message.
void	contains(CharSequence string) Fails if the string does not contain the given sequence.
void	containsMatch(Pattern pattern) Fails if the string does not contain a match on the given regex.
void	containsMatch(String regex) Fails if the string does not contain a match on the given regex.
void	doesNotContain(CharSequence string) Fails if the string contains the given sequence.
void	doesNotContainMatch(Pattern pattern) Fails if the string contains a match on the given regex.
void	doesNotContainMatch(String regex) Fails if the string contains a match on the given regex.
void	doesNotMatch(Pattern regex) Fails if the string matches the given regex.
void	doesNotMatch(String regex) Fails if the string matches the given regex.
void	endsWith(String string) Fails if the string does not end with the given string.
void	hasLength(int expectedLength) Fails if the string does not have the given length.
void	isEmpty() Fails if the string is not equal to the zero-length "empty string."
void	isEqualTo(Object expected) Fails if the subject is not equal to the given object.
void	isEquivalentAccordingToCompareTo(String other) Deprecated. Use isEqualTo(java.lang.Object) instead. String comparison is consistent with equality.
void	isNotEmpty() Fails if the string is equal to the zero-length "empty string."
void	isNull() Fails if the string is not null.
void	matches(Pattern regex) Fails if the string does not match the given regex.
void	matches(String regex) Fails if the string does not match the given regex.
void	startsWith(String string) Fails if the string does not start with the given string.

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

comparesEqualTo, isAtLeast, isAtMost, isGreaterThan, isIn, isLessThan, isNotIn

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

actual, actualAsString, check, equals, fail, fail, fail, failComparing, failComparing, failWithBadResults, failWithCustomSubject, failWithoutActual, failWithoutSubject, failWithRawMessage, failWithRawMessageAndCause, getDisplaySubject, getSubject, hashCode, ignoreCheck, internalCustomName, isAnyOf, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameAs, isSameAs, named

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSubject

@Deprecated
public StringSubject(FailureStrategy failureStrategy,
                                 @Nullable
                                 String string)

Deprecated. Switch your Subject from accepting FailureStrategy (and exposing a SubjectFactory) to accepting a FailureMetadata (and exposing a Subject.Factory), at which point you'll call the FailureMetadata overload of this constructor instead.

StringSubject

public StringSubject(FailureMetadata metadata,
                     @Nullable
                     String string)

Method Detail

actualCustomStringRepresentation

protected String actualCustomStringRepresentation()

Description copied from class: Subject

Supplies the direct string representation of the actual value to other methods which may prefix or otherwise position it in an error message. This should only be overridden to provide an improved string representation of the value under test, as it would appear in any given error message, and should not be used for additional prefixing.

Subjects should override this with care.

By default, this returns String.ValueOf(getActualValue()).

Overrides:

actualCustomStringRepresentation in class Subject<StringSubject,String>

isEqualTo

public void isEqualTo(@Nullable
                      Object expected)

Description copied from class: Subject

Fails if the subject is not equal to the given object. For the purposes of this comparison, two objects are equal if any of the following is true:

• they are equal according to Objects.equal(java.lang.Object, java.lang.Object)
• they are arrays and are considered equal by the appropriate Arrays#equals overload
• they are boxed integer types (Byte, Short, Character, Integer, or Long) and they are numerically equal when converted to Long.

Overrides:

isEqualTo in class Subject<StringSubject,String>

isEquivalentAccordingToCompareTo

@Deprecated
public final void isEquivalentAccordingToCompareTo(String other)

Deprecated. Use isEqualTo(java.lang.Object) instead. String comparison is consistent with equality.

Description copied from class: ComparableSubject

Fails if the subject is not equivalent to the given value according to Comparable.compareTo(T), (i.e., fails if a.comparesTo(b) != 0).

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

Overrides:

isEquivalentAccordingToCompareTo in class ComparableSubject<StringSubject,String>

isNull

public void isNull()

Fails if the string is not null.

Overrides:

isNull in class Subject<StringSubject,String>

hasLength

public void hasLength(int expectedLength)

Fails if the string does not have the given length.

isEmpty

public void isEmpty()

Fails if the string is not equal to the zero-length "empty string."

isNotEmpty

public void isNotEmpty()

Fails if the string is equal to the zero-length "empty string."

contains

public void contains(CharSequence string)

Fails if the string does not contain the given sequence.

doesNotContain

public void doesNotContain(CharSequence string)

Fails if the string contains the given sequence.

startsWith

public void startsWith(String string)

Fails if the string does not start with the given string.

endsWith

public void endsWith(String string)

Fails if the string does not end with the given string.

matches

public void matches(String regex)

Fails if the string does not match the given regex.

matches

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

Fails if the string does not match the given regex.

doesNotMatch

public void doesNotMatch(String regex)

Fails if the string matches the given regex.

doesNotMatch

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

Fails if the string matches the given regex.

containsMatch

@GwtIncompatible(value="java.util.regex.Pattern")
public void containsMatch(Pattern pattern)

Fails if the string does not contain a match on the given regex.

containsMatch

public void containsMatch(String regex)

Fails if the string does not contain a match on the given regex.

doesNotContainMatch

@GwtIncompatible(value="java.util.regex.Pattern")
public void doesNotContainMatch(Pattern pattern)

Fails if the string contains a match on the given regex.

doesNotContainMatch

public void doesNotContainMatch(String regex)

Fails if the string contains a match on the given regex.