Hamcrest-Qt  0.0.1
Hamcrest matchers for C++/Qt
 All Classes Namespaces Functions
Public Member Functions | List of all members
HamcrestQt::Matcher< T > Class Template Referenceabstract

A matcher over acceptable values. More...

#include <matcher.h>

Inheritance diagram for HamcrestQt::Matcher< T >:
HamcrestQt::SelfDescribing HamcrestQt::BaseMatcher< T > HamcrestQt::DiagnosingMatcher< T > HamcrestQt::Is< T > HamcrestQt::IsEqual< T > HamcrestQt::IsNot< T > HamcrestQt::ShortcutCombination< T > HamcrestQt::AllOf< T > HamcrestQt::AnyOf< T >

Public Member Functions

virtual bool matches (const T &item) const =0
 Evaluates the matcher for argument item. More...
 
virtual void describeMismatch (const T &item, Description &mismatchDescription) const =0
 Generate a description of why the matcher has not accepted the item. More...
 
virtual QString toString () const =0
 
- Public Member Functions inherited from HamcrestQt::SelfDescribing
virtual void describeTo (Description &description) const =0
 Generates a description of the object. More...
 

Detailed Description

template<typename T>
class HamcrestQt::Matcher< T >

A matcher over acceptable values.

A matcher is able to describe itself to give feedback when it fails.

See Also
BaseMatcher

Member Function Documentation

template<typename T>
virtual void HamcrestQt::Matcher< T >::describeMismatch ( const T &  item,
Description mismatchDescription 
) const
pure virtual

Generate a description of why the matcher has not accepted the item.

The description will be part of a larger description of why a matching failed, so it should be concise. This method assumes that matches(item) is false, but will not check this.

Parameters
itemThe item that the Matcher has rejected.
mismatchDescriptionThe description to be built or appended to.

Implemented in HamcrestQt::Is< T >, HamcrestQt::SubstringMatcher, HamcrestQt::BaseMatcher< T >, HamcrestQt::BaseMatcher< QString >, and HamcrestQt::DiagnosingMatcher< T >.

template<typename T>
virtual bool HamcrestQt::Matcher< T >::matches ( const T &  item) const
pure virtual

Evaluates the matcher for argument item.

Parameters
itemthe object against which the matcher is evaluated.
Returns
true if item matches, otherwise false.
See Also
BaseMatcher

Implemented in HamcrestQt::Is< T >, HamcrestQt::IsEqual< T >, HamcrestQt::AnyOf< T >, HamcrestQt::IsNot< T >, HamcrestQt::DiagnosingMatcher< T >, and HamcrestQt::SubstringMatcher.


The documentation for this class was generated from the following file: