org.cthul.matchers.fluent8

Interface StringFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

All Superinterfaces:

ComparableFluent<String,Value,BaseFluent,TheFluent,This>, org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value,BaseFluent,TheFluent,This>, org.cthul.matchers.fluent.FluentStep<Value,BaseFluent>, ObjectFluent<Value,BaseFluent,TheFluent,This>

All Known Subinterfaces:

StringFluent.AndChain<Value,TheFluent,This>, StringFluent.OrChain<Value,TheFluent,This>

All Known Implementing Classes:

StringFluent.Assert, StringFluent.Step

public interface StringFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>
extends org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value,BaseFluent,TheFluent,This>, ComparableFluent<String,Value,BaseFluent,TheFluent,This>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StringFluent.AndChain<Value extends String,TheFluent,This extends StringFluent.AndChain<Value,TheFluent,This>>
static class	StringFluent.Assert<Value extends String>
static interface	StringFluent.OrChain<Value extends String,TheFluent,This extends StringFluent.OrChain<Value,TheFluent,This>>
static class	StringFluent.Step<Value extends String,TheFluent,This extends StringFluent.Step<Value,TheFluent,This>>

Method Summary

Modifier and Type	Method and Description
StringFluent.AndChain<Value,TheFluent,?>	all()
StringFluent.AndChain<Value,TheFluent,?>	both()
StringFluent.AndChain<Value,TheFluent,?>	both(org.hamcrest.Matcher<? super Value> matcher)
default TheFluent	contains(String substring) Creates a matcher that matches if the examined String contains the specified String anywhere.
default TheFluent	containsInOrder(Iterable<String> substrings) Creates a matcher of String that matches when the examined string contains all of the specified substrings, regardless of the order of their appearance.
default TheFluent	containsPattern(Pattern p) Can the given pattern be found in the string?
default TheFluent	containsPattern(String regex) Can the given pattern be found in the string?
StringFluent.OrChain<Value,TheFluent,?>	either()
StringFluent.OrChain<Value,TheFluent,?>	either(org.hamcrest.Matcher<? super Value> matcher)
default TheFluent	endsWith(String suffix) Creates a matcher that matches if the examined String ends with the specified String.
default TheFluent	equalToIgnoringCase(String expectedString) Creates a matcher of String that matches when the examined string is equal to the specified expectedString, ignoring case.
default TheFluent	equalToIgnoringWhiteSpace(String expectedString) Creates a matcher of String that matches when the examined string is equal to the specified expectedString, when whitespace differences are (mostly) ignored.
default TheFluent	isEmpty() Creates a matcher of String that matches when the examined string has zero length.
default TheFluent	isEmptyOrNull() Creates a matcher of String that matches when the examined string is null, or has zero length.
default TheFluent	matches(Pattern p) Does the pattern match the entire string?
default TheFluent	matches(String regex) Does the pattern match the entire string?
default TheFluent	startsWith(String prefix) Creates a matcher that matches if the examined String starts with the specified String.

Methods inherited from interface org.cthul.matchers.fluent8.ComparableFluent

comparesEqualTo, greaterThan, greaterThanOrEqualTo, lessThan, lessThanOrEqualTo

Methods inherited from interface org.cthul.matchers.fluent8.ObjectFluent

get, get, hasToString, hasToString, isIn, isIn, isOneOf, notNullValue, nullValue, sameInstance, theInstance

Methods inherited from interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep

__, __, __, allOf, anyOf, as, as, equalTo, has, has, has, has, hasNot, hasNot, hasNot, hasNot, hasType, is, is, is, isA, isNot, isNot, isNot, noneOf, not, not, not, not, not

Method Detail

containsPattern

default TheFluent containsPattern(String regex)

Can the given pattern be found in the string?

Parameters:

regex -

Returns:

fluent

See Also:

ContainsPattern.containsPattern(java.lang.String)

containsPattern

default TheFluent containsPattern(Pattern p)

Can the given pattern be found in the string?

Parameters:

p -

Returns:

fluent

See Also:

ContainsPattern.containsPattern(java.util.regex.Pattern)

matches

default TheFluent matches(String regex)

Does the pattern match the entire string?

Parameters:

regex -

Returns:

fluent

See Also:

ContainsPattern.matchesPattern(java.lang.String)

matches

default TheFluent matches(Pattern p)

Does the pattern match the entire string?

Parameters:

p -

Returns:

fluent

See Also:

ContainsPattern.matchesPattern(java.util.regex.Pattern)

contains

default TheFluent contains(String substring)

Creates a matcher that matches if the examined String contains the specified String anywhere.

For example:

assertThat("myStringOfNote", containsString("ring"))

Parameters:

substring - the substring that the returned matcher will expect to find within any examined string

Returns:

fluent

See Also:

StringContains.containsString(java.lang.String)

startsWith

default TheFluent startsWith(String prefix)

Creates a matcher that matches if the examined String starts with the specified String.

For example:

assertThat("myStringOfNote", startsWith("my"))

Parameters:

prefix - the substring that the returned matcher will expect at the start of any examined string

Returns:

fluent

See Also:

StringStartsWith.startsWith(java.lang.String)

endsWith

default TheFluent endsWith(String suffix)

Creates a matcher that matches if the examined String ends with the specified String.

For example:

assertThat("myStringOfNote", endsWith("Note"))

Parameters:

suffix - the substring that the returned matcher will expect at the end of any examined string

Returns:

fluent

See Also:

StringEndsWith.endsWith(java.lang.String)

equalToIgnoringCase

default TheFluent equalToIgnoringCase(String expectedString)

Creates a matcher of String that matches when the examined string is equal to the specified expectedString, ignoring case.

For example:

assertThat("Foo", equalToIgnoringCase("FOO"))

Parameters:

expectedString - the expected value of matched strings

Returns:

fluent

See Also:

IsEqualIgnoringCase.equalToIgnoringCase(java.lang.String)

equalToIgnoringWhiteSpace

default TheFluent equalToIgnoringWhiteSpace(String expectedString)

Creates a matcher of String that matches when the examined string is equal to the specified expectedString, when whitespace differences are (mostly) ignored. To be exact, the following whitespace rules are applied:

• all leading and trailing whitespace of both the expectedString and the examined string are ignored
• any remaining whitespace, appearing within either string, is collapsed to a single space before comparison

For example:

assertThat("   my\tfoo  bar ", equalToIgnoringWhiteSpace(" my  foo bar"))

Parameters:

expectedString - the expected value of matched strings

Returns:

fluent

See Also:

IsEqualIgnoringWhiteSpace.equalToIgnoringWhiteSpace(java.lang.String)

isEmpty

default TheFluent isEmpty()

Creates a matcher of String that matches when the examined string has zero length.

For example:

assertThat("", isEmptyString())

Returns:

fluent

See Also:

IsEmptyString.isEmptyString()

isEmptyOrNull

default TheFluent isEmptyOrNull()

Creates a matcher of String that matches when the examined string is null, or has zero length.

For example:

assertThat(((String)null), isEmptyString())

Returns:

fluent

See Also:

IsEmptyString.isEmptyOrNullString()

containsInOrder

default TheFluent containsInOrder(Iterable<String> substrings)

Creates a matcher of String that matches when the examined string contains all of the specified substrings, regardless of the order of their appearance.

For example:

assertThat("myfoobarbaz", stringContainsInOrder(Arrays.asList("bar", "foo")))

Parameters:

substrings - the substrings that must be contained within matching strings

Returns:

fluent

See Also:

StringContainsInOrder.stringContainsInOrder(java.lang.Iterable)

either

StringFluent.OrChain<Value,TheFluent,?> either()

Specified by:

either in interface ComparableFluent<String,Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.FluentStep<Value extends String,BaseFluent>

Specified by:

either in interface ObjectFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

either

StringFluent.OrChain<Value,TheFluent,?> either(org.hamcrest.Matcher<? super Value> matcher)

Specified by:

either in interface ComparableFluent<String,Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

either in interface org.cthul.matchers.fluent.FluentStep<Value extends String,BaseFluent>

Specified by:

either in interface ObjectFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

both

StringFluent.AndChain<Value,TheFluent,?> both()

Specified by:

both in interface ComparableFluent<String,Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.FluentStep<Value extends String,BaseFluent>

Specified by:

both in interface ObjectFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

both

StringFluent.AndChain<Value,TheFluent,?> both(org.hamcrest.Matcher<? super Value> matcher)

Specified by:

both in interface ComparableFluent<String,Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

both in interface org.cthul.matchers.fluent.FluentStep<Value extends String,BaseFluent>

Specified by:

both in interface ObjectFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

all

StringFluent.AndChain<Value,TheFluent,?> all()

Specified by:

all in interface ComparableFluent<String,Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

all in interface org.cthul.matchers.fluent.ext.ExtensibleFluentStep<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>

Specified by:

all in interface org.cthul.matchers.fluent.FluentStep<Value extends String,BaseFluent>

Specified by:

all in interface ObjectFluent<Value extends String,BaseFluent,TheFluent extends BaseFluent,This extends StringFluent<Value,BaseFluent,TheFluent,This>>