Module: Xqsr3::Quality::ParameterChecking

Included in:
XML::Utilities::Compare::Internal_Compare_, XML::Utilities::Compare::Result
Defined in:
lib/xqsr3/quality/parameter_checking.rb

Overview

Inclusion module that creates class and instance methods check_parameter that may be used to check parameter values and types

Defined Under Namespace

Modules: Util_

Class Method Summary collapse

Class Method Details

.check_param(value, name, options = {}, &block) ⇒ Object

Note:

This is obsolete, and will be removed in a future version.

Please use check_parameter instead

See Also:



193
194
195
196
 
# File 'lib/xqsr3/quality/parameter_checking.rb', line 193

def self.check_param value, name, options = {}, &block

	Util_.check_parameter value, name, options, &block
end

.check_parameter(value, name, options = {}, &block) ⇒ Object

Check a given parameter (value=value, name=name) for type and value

Parameters:

  • +value+ —

    the parameter whose value and type is to be checked

  • +name+ —

    the name of the parameter to be checked

  • +options+ —

    options

  • +:allow_nil+ (Hash) —

    a customizable set of options

  • +:nil+ (Hash) —

    a customizable set of options

  • +:types+ (Hash) —

    a customizable set of options

  • +:type+ (Hash) —

    a customizable set of options

  • +:values+ (Hash) —

    a customizable set of options

  • +:responds_to+ (Hash) —

    a customizable set of options

  • +:reject_empty+ (Hash) —

    a customizable set of options

  • +:require_empty+ (Hash) —

    a customizable set of options

  • +:nothrow+ (Hash) —

    a customizable set of options

  • +:message+ (Hash) —

    a customizable set of options

  • +:treat_as_option+ (Hash) —

    a customizable set of options



184
185
186
187
 
# File 'lib/xqsr3/quality/parameter_checking.rb', line 184

def self.check_parameter value, name, options = {}, &block

	Util_.check_parameter value, name, options, &block
end

.included(base) ⇒ Object 



81
82
83
84
 
# File 'lib/xqsr3/quality/parameter_checking.rb', line 81

def self.included base

	base.extend self
end