Deepsolver
Public Member Functions
Deepsolver::PkgBackEndException Class Reference

Indicates an error inside of package back-end. More...

Inheritance diagram for Deepsolver::PkgBackEndException:
Deepsolver::AbstractException

List of all members.

Public Member Functions

void accept (ExceptionVisitor &visitor) const
 Calls appropriate visitor method.
const std::string & getFnName () const
 Returns the name of the function caused the error.
std::string getMessage () const
 Returns a single line error description.
std::string getType () const
 Returns a string with short error type designation.
 PkgBackEndException (const std::string &fnName)
 The constructor.
virtual ~PkgBackEndException ()
 The destructor.

Detailed Description

This class represents an exception in package back-end layer. There can be several package back-end implementations (rpm, dpkg etc), but all of them should use this type of exception to unify errors handling in command line tools and other libdeepsolver clients. The preferable parameter for this class instance is a failed function name.


Constructor & Destructor Documentation

Deepsolver::PkgBackEndException::PkgBackEndException ( const std::string &  fnName) [inline]
Parameters:
[in]fnNameA name of a failed function

Member Function Documentation

void Deepsolver::PkgBackEndException::accept ( ExceptionVisitor visitor) const [inline, virtual]

This method performs invocation of corresponding visit() method of the visitor, provided by the reference. You should use it each time, when you want to make particular handling action for various exception types, as it suggested by design pattern "visitor".

Parameters:
[in]visitorThe reference to the visitor

Implements Deepsolver::AbstractException.

const std::string& Deepsolver::PkgBackEndException::getFnName ( ) const [inline]
Returns:
The name of the function caused the error
std::string Deepsolver::PkgBackEndException::getMessage ( ) const [virtual]

This method returns a single line string value with error description. Usually it is the value printed to user in the error message. The value should not include error type, since it can be obtained through getType() method.

Returns:
A single line error description

Implements Deepsolver::AbstractException.

std::string Deepsolver::PkgBackEndException::getType ( ) const [inline, virtual]

This method returns a short string with one or two words describing the error type. For example, this method can return values like "system", "back-end" etc. A value returned by this method usually is used for error message construction.

Returns:
A short string with error type designation

Implements Deepsolver::AbstractException.