Class: Cuprum::Errors::InvalidParameters

Inherits:
Cuprum::Error show all
Defined in:
lib/cuprum/errors/invalid_parameters.rb

Overview

Error returned when a command’s parameters fail validation.

Constant Summary collapse

TYPE =

Short string used to identify the type of error.

'cuprum.errors.invalid_parameters'

Instance Attribute Summary collapse

Attributes inherited from Cuprum::Error

#message, #type

Instance Method Summary collapse

Methods inherited from Cuprum::Error

#==, #as_json

Constructor Details

#initialize(command_class:, failures:) ⇒ InvalidParameters

Returns a new instance of InvalidParameters.

Parameters:

  • command_class (Class) —

    the class of the failed command.

  • failures (Array<String>) —

    the messages for the failed validations.



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/cuprum/errors/invalid_parameters.rb', line 14

def initialize(command_class:, failures:)
  @command_class = command_class
  @failures      = failures

  super(
    command_class:,
    failures:,
    message:       generate_message
  )
end

Instance Attribute Details

#command_class ⇒ Class (readonly)

Returns the class of the failed command.

Returns:

  • (Class) —

    the class of the failed command.



26
27
28
 
# File 'lib/cuprum/errors/invalid_parameters.rb', line 26

def command_class
  @command_class
end

#failures ⇒ Array<String> (readonly)

Returns the messages for the failed validations.

Returns:

  • (Array<String>) —

    the messages for the failed validations.



29
30
31
 
# File 'lib/cuprum/errors/invalid_parameters.rb', line 29

def failures
  @failures
end