Exception: Common::ParameterError

Inherits:

CloudboxError

• Object
• StandardError
• CloudboxError
• Common::ParameterError

Defined in:

lib/common/cloudbox_exceptions.rb

Overview

The class which list all parameters errors

Direct Known Subclasses

InconsistentParameter, InvalidParameter, MissingParameter

Instance Method Summary

• #initialize(msg, usage) ⇒ ParameterError constructor

  Default constructor of the class.

• #usage ⇒ Object

  Return the usage help of the class calling the exception.

Constructor Details

#initialize(msg, usage) ⇒ ParameterError

Note:

Overrides default constructor by passing CustomCommandOption to super().

Default constructor of the class.

# File 'lib/common/cloudbox_exceptions.rb', line 14

def initialize(msg, usage)
  @usage = usage
  super(msg)
end

Instance Method Details

#usage ⇒ Object

Return the usage help of the class calling the exception

Author:

• mbretaud

# File 'lib/common/cloudbox_exceptions.rb', line 21

def usage()
  return @usage
end