Class: Cuprum::Errors::InvalidParameters

Parent Namespace

Cuprum::Errors

Inherited Classes

Cuprum::Error > Object

Defined In

lib/cuprum/errors/invalid_parameters.rb

Table Of Contents

• Overview
• Constants
  • TYPE
• Constructor
• Instance Attributes
  • command_class
  • failures
  • message
  • type
• Instance Methods
  • ==
  • as_json
  • initialize

Overview

Error returned when a command’s parameters fail validation.

Back To Top

Constants

TYPE

= 'cuprum.errors.invalid_parameters'

Short string used to identify the type of error.

Back To Top

Constructor

#initialize(command_class:, failures:) => InvalidParameters

Parameters

• command_class (Class) — the class of the failed command.
• failures (Array<String>) — the messages for the failed validations.

Returns

• (InvalidParameters) — a new instance of InvalidParameters

Back To Top

Instance Attributes

#command_class => Class (readonly)

Returns

• (Class) — the class of the failed command.

#failures => Array<String> (readonly)

Returns

• (Array<String>) — the messages for the failed validations.

#message => String (readonly)

Inherited From

Cuprum::Error

Returns

• (String) — optional message describing the nature of the error.

#type => String (readonly)

Inherited From

Cuprum::Error

Returns

• (String) — short string used to identify the type of error.

Back To Top

Instance Methods

#==(other) => Boolean

Inherited From

Cuprum::Error

Parameters

• other (Cuprum::Error) — The other object to compare.

Returns

• (Boolean) — true if the other object has the same class and properties; otherwise false.

#as_json => Hash<String, Object>

Inherited From

Cuprum::Error

Generates a serializable representation of the error object.

By default, contains the #type and #message properties and an empty :data Hash. This can be overridden in subclasses by overriding the private method #as_json_data; this should always return a Hash with String keys and whose values are basic objects or data structures of the same.

Returns

• (Hash<String, Object>) — a serializable hash representation of the error.

Back To Top

---

Back to Documentation | Reference | Cuprum | Cuprum::Errors