Deepsolver
Public Types | Public Member Functions
Deepsolver::InfoFileValueException Class Reference

The exception class for invalid info file value. More...

Inheritance diagram for Deepsolver::InfoFileValueException:
Deepsolver::AbstractException

List of all members.

Public Types

enum  { InvalidFormatType, InvalidCompressionType, InvalidBooleanValue }

Public Member Functions

void accept (ExceptionVisitor &visitor) const
 Calls appropriate visitor method.
int getCode () const
 Returns the error code.
std::string getMessage () const
 Returns a single line error description.
const std::string & getParam () const
 Returns the error parameter.
std::string getType () const
 Returns a string with short error type designation.
 InfoFileValueException (int code, const std::string &param)
 The constructor.
virtual ~InfoFileValueException ()
 The destructor.

Detailed Description

This exception class indicates that info file, got as a repository header, contains an incorrect value. This error should not be confused with other types of info file problems, e.g. InfoFileSyntaxException. An incorrect value means cases when obtained string does not belong to the list of proper values forsome particular parameter. Such problem can be faced with boolean parameters or with the parameters implying fixed set of values, like compression type ("none", "gzip" etc).

See also:
InfoFileSyntaxException

Constructor & Destructor Documentation

Deepsolver::InfoFileValueException::InfoFileValueException ( int  code,
const std::string &  param 
) [inline]
Parameters:
[in]codeThe error code
[in]paramThe string error parameter

Member Function Documentation

void Deepsolver::InfoFileValueException::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.

int Deepsolver::InfoFileValueException::getCode ( ) const [inline]
Returns:
The error code
std::string Deepsolver::InfoFileValueException::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.

const std::string& Deepsolver::InfoFileValueException::getParam ( ) const [inline]
Returns:
The error parameter
std::string Deepsolver::InfoFileValueException::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.