Message.h

Go to the documentation of this file.

#ifndef CPPUNIT_MESSAGE_H
#define CPPUNIT_MESSAGE_H
 
#include <cppunit/Portability.h>
 
#if CPPUNIT_NEED_DLL_DECL
#pragma warning( push )
#pragma warning( disable: 4251 )  // X needs to have dll-interface to be used by clients of class Z
#endif
 
#include <cppunit/portability/CppUnitDeque.h>
#include <string>
 
 
CPPUNIT_NS_BEGIN
 
 
#if CPPUNIT_NEED_DLL_DECL
//  template class CPPUNIT_API std::deque<std::string>;
#endif

class CPPUNIT_API Message
{
public:
  Message();
 
  // Ensure thread-safe copy by detaching the string.
  Message( const Message &other );
 
  explicit Message( const std::string &shortDescription );
 
  Message( const std::string &shortDescription,
           const std::string &detail1 );
 
  Message( const std::string &shortDescription,
           const std::string &detail1,
           const std::string &detail2 );
 
  Message( const std::string &shortDescription,
           const std::string &detail1,
           const std::string &detail2,
           const std::string &detail3 );
 
  Message &operator =( const Message &other );

  const std::string &shortDescription() const;

  int detailCount() const;

  std::string detailAt( int index ) const;

  std::string details() const;

  void clearDetails();

  void addDetail( const std::string &detail );

  void addDetail( const std::string &detail1,
                  const std::string &detail2 );

  void addDetail( const std::string &detail1,
                  const std::string &detail2,
                  const std::string &detail3 );

  void addDetail( const Message &message );

  void setShortDescription( const std::string &shortDescription );

  bool operator ==( const Message &other ) const;

  bool operator !=( const Message &other ) const;
 
private:
  std::string m_shortDescription;
 
  typedef CppUnitDeque<std::string> Details;
  Details m_details;
};
 
 
CPPUNIT_NS_END
 
#if CPPUNIT_NEED_DLL_DECL
#pragma warning( pop )
#endif
 
 
#endif  // CPPUNIT_MESSAGE_H