module Athena::Validator::Violation::ConstraintViolationBuilderInterface

Overview

A Builder Pattern type for building AVD::Violation::ConstraintViolationInterfaces.

Allows using the methods defined on self to construct the desired violation before adding it to the context.

Direct including types

Defined in:

violation/constraint_violation_builder_interface.cr

Instance Method Summary

Instance Method Detail

abstract def add : Nil #

Adds the violation to the current AVD::ExecutionContextInterface.


[View source]
abstract def add_parameter(key : String, value : _) : AVD::Violation::ConstraintViolationBuilderInterface #

Adds a parameter with the provided key and value to the violations' AVD::Violation::ConstraintViolationInterface#parameters. The provided value is stringified via #to_s before being added to the parameters.

Returns self for chaining.


[View source]
abstract def at_path(path : String) : AVD::Violation::ConstraintViolationBuilderInterface #

Sets the AVD::Violation::ConstraintViolationInterface#property_path.

Returns self for chaining.


[View source]
abstract def cause(cause : String?) : AVD::Violation::ConstraintViolationBuilderInterface #

Sets the AVD::Violation::ConstraintViolationInterface#cause

Returns self for chaining.


[View source]
abstract def code(code : String?) : AVD::Violation::ConstraintViolationBuilderInterface #

Sets the AVD::Violation::ConstraintViolationInterface#code

Returns self for chaining.


[View source]
abstract def constraint(constraint : AVD::Constraint?) : AVD::Violation::ConstraintViolationBuilderInterface #

Sets the AVD::Violation::ConstraintViolationInterface#constraint

Returns self for chaining.


[View source]
abstract def invalid_value(value : _) : AVD::Violation::ConstraintViolationBuilderInterface #

[View source]
abstract def plural(number : Int32) : AVD::Violation::ConstraintViolationBuilderInterface #

Sets AVD::Violation::ConstraintViolationInterface#plural

Returns self for chaining.


[View source]
abstract def set_parameters(parameters : Hash(String, String)) : AVD::Violation::ConstraintViolationBuilderInterface #

Overrides the entire AVD::Violation::ConstraintViolationInterface#parameters hash with the provided parameters.

Returns self for chaining.


[View source]