<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>Class: Caricature::ExpectationBuilder</title>
<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
<script src="../js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="../js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="class">
<div id="metadata">
<div id="file-metadata">
<div id="file-list-section" class="section">
<h3 class="section-header">In Files</h3>
<div class="section-body">
<ul>
<li><a href="../lib/caricature/expectation_rb.html?TB_iframe=true&height=550&width=785"
class="thickbox" title="lib/caricature/expectation.rb">lib/caricature/expectation.rb</a></li>
</ul>
</div>
</div>
</div>
<div id="class-metadata">
<!-- Parent Class -->
<div id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="../Object.html">Object</a></p>
</div>
<!-- Namespace Contents -->
<!-- Method Quickref -->
<div id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#M000049">::new</a></li>
<li><a href="#M000051">#build</a></li>
</ul>
</div>
<!-- Included Modules -->
<div id="includes-section" class="section">
<h3 class="section-header">Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Interception.html">Caricature::Interception</a></li>
</ul>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="../README_markdown.html">README.markdown</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="../images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="../Caricature.html">Caricature</a></li>
<li><a href="../Caricature/ArgumentRecording.html">Caricature::ArgumentRecording</a></li>
<li><a href="../Caricature/ClrClassDescriptor.html">Caricature::ClrClassDescriptor</a></li>
<li><a href="../Caricature/ClrClassMessenger.html">Caricature::ClrClassMessenger</a></li>
<li><a href="../Caricature/ClrInterfaceDescriptor.html">Caricature::ClrInterfaceDescriptor</a></li>
<li><a href="../Caricature/ClrInterfaceIsolator.html">Caricature::ClrInterfaceIsolator</a></li>
<li><a href="../Caricature/ClrInterfaceMessenger.html">Caricature::ClrInterfaceMessenger</a></li>
<li><a href="../Caricature/ClrIsolator.html">Caricature::ClrIsolator</a></li>
<li><a href="../Caricature/Expectation.html">Caricature::Expectation</a></li>
<li><a href="../Caricature/ExpectationBuilder.html">Caricature::ExpectationBuilder</a></li>
<li><a href="../Caricature/ExpectationSyntax.html">Caricature::ExpectationSyntax</a></li>
<li><a href="../Caricature/Expectations.html">Caricature::Expectations</a></li>
<li><a href="../Caricature/Interception.html">Caricature::Interception</a></li>
<li><a href="../Caricature/Interception/ClassMethods.html">Caricature::Interception::ClassMethods</a></li>
<li><a href="../Caricature/Isolation.html">Caricature::Isolation</a></li>
<li><a href="../Caricature/Isolator.html">Caricature::Isolator</a></li>
<li><a href="../Caricature/MemberDescriptor.html">Caricature::MemberDescriptor</a></li>
<li><a href="../Caricature/Messenger.html">Caricature::Messenger</a></li>
<li><a href="../Caricature/MethodCallRecorder.html">Caricature::MethodCallRecorder</a></li>
<li><a href="../Caricature/MethodCallRecording.html">Caricature::MethodCallRecording</a></li>
<li><a href="../Caricature/RubyIsolator.html">Caricature::RubyIsolator</a></li>
<li><a href="../Caricature/RubyMessenger.html">Caricature::RubyMessenger</a></li>
<li><a href="../Caricature/RubyObjectDescriptor.html">Caricature::RubyObjectDescriptor</a></li>
<li><a href="../Caricature/TypeDescriptor.html">Caricature::TypeDescriptor</a></li>
<li><a href="../Caricature/Verification.html">Caricature::Verification</a></li>
<li><a href="../System.html">System</a></li>
<li><a href="../System/String.html">System::String</a></li>
<li><a href="../System/Type.html">System::Type</a></li>
<li><a href="../Array.html">Array</a></li>
<li><a href="../Class.html">Class</a></li>
<li><a href="../Hash.html">Hash</a></li>
<li><a href="../Module.html">Module</a></li>
<li><a href="../Object.html">Object</a></li>
<li><a href="../String.html">String</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1 class="class">Caricature::ExpectationBuilder</h1>
<div id="description">
<p>
Constructs the expecation object. Used as a boundary between the definition
and usage of the expectation
</p>
</div>
<!-- Constants -->
<!-- Attributes -->
<!-- Methods -->
<div id="public-class-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="new-method" class="method-detail ">
<a name="M000049"></a>
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(method_name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
initialises a new instance of the expectation builder this builder is
passed into the block to allow only certain operations in the block.
</p>
<div class="method-source-code"
id="new-source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 146</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">method_name</span>)
<span class="ruby-ivar">@method_name</span>, <span class="ruby-ivar">@return_value</span>, <span class="ruby-ivar">@super</span>, <span class="ruby-ivar">@block</span>, <span class="ruby-ivar">@error_args</span>, <span class="ruby-ivar">@args</span>, <span class="ruby-ivar">@any_args</span> =
<span class="ruby-identifier">method_name</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-keyword kw">nil</span>, [], <span class="ruby-keyword kw">true</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
<div id="public-instance-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="build-method" class="method-detail ">
<a name="M000051"></a>
<div class="method-heading">
<span class="method-name">build</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>
build up the expectation with the provided arguments
</p>
<div class="method-source-code"
id="build-source">
<pre>
<span class="ruby-comment cmt"># File lib/caricature/expectation.rb, line 154</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>
<span class="ruby-constant">Expectation</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@method_name</span>, <span class="ruby-ivar">@args</span>, <span class="ruby-ivar">@error_args</span>, <span class="ruby-ivar">@return_value</span>, <span class="ruby-ivar">@super</span>
<span class="ruby-keyword kw">end</span></pre>
</div>
</div>
</div>
</div>
</div>
<div id="rdoc-debugging-section-dump" class="debugging-section">
<p>Disabled; run with --debug to generate this.</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>