<!DOCTYPE html>
<html lang="en">
<head>
<title>Configuration Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Configuration" class="dashAnchor"></a>
<a title="Configuration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">SwiftyMocky Docs</a> (95% documented)</p>
<p class="header-right"><a href="https://github.com/MakeAWishFoundation/SwiftyMocky"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">SwiftyMocky Reference</a>
<img id="carat" src="img/carat.png" />
Configuration Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="overview.html">Overview</a>
</li>
<li class="nav-group-task">
<a href="supported-features.html">Supported features</a>
</li>
<li class="nav-group-task">
<a href="installation.html">Installation</a>
</li>
<li class="nav-group-task">
<a href="setup-in-project.html">Setup in project</a>
</li>
<li class="nav-group-task">
<a href="matcher-support-for-not-equatable.html">Matcher support for not Equatable</a>
</li>
<li class="nav-group-task">
<a href="handling-generics.html">Handling Generics</a>
</li>
<li class="nav-group-task">
<a href="examples.html">Examples</a>
</li>
<li class="nav-group-task">
<a href="custom-subspec.html">Custom Subspec</a>
</li>
<li class="nav-group-task">
<a href="add-xcode-generate-action.html">Add XCode generate action</a>
</li>
<li class="nav-group-task">
<a href="known-issues.html">Known issues</a>
</li>
<li class="nav-group-task">
<a href="changelog.html">CHANGELOG</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global methods.html">Global methods</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky5Givenyyx_ABQzAA14StubbingPolicyOtAA4MockRzlF">Given(_:_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky5Givenyyxm_06StaticC0QzAA14StubbingPolicyOtAA0D4MockRzlF">Given(_:_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky7Performyyx_ABQztAA4MockRzlF">Perform(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky7Performyyxm_06StaticC0QztAA0D4MockRzlF">Perform(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky6Verify__4file4lineyx_ABQzs12StaticStringVSutAA4MockRzlF">Verify(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky6Verify__4file4lineyxm_06StaticC0Qzs0F6StringVSutAA0F4MockRzlF">Verify(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky6Verify___4file4lineyx_AA5CountVABQzs12StaticStringVSutAA4MockRzlF">Verify(_:_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Global methods.html#/s:11SwiftyMocky6Verify___4file4lineyxm_AA5CountV06StaticC0Qzs0G6StringVSutAA0G4MockRzlF">Verify(_:_:_:file:line:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Configuration.html">Configuration</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/StubbingPolicy.html">StubbingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Enums/SequencingPolicy.html">SequencingPolicy</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Types.html">Types</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/Mock.html">Mock</a>
</li>
<li class="nav-group-task">
<a href="Protocols/StaticMock.html">StaticMock</a>
</li>
<li class="nav-group-task">
<a href="Enums/Parameter.html">Parameter</a>
</li>
<li class="nav-group-task">
<a href="Classes/Matcher.html">Matcher</a>
</li>
<li class="nav-group-task">
<a href="Protocols/Countable.html">Countable</a>
</li>
<li class="nav-group-task">
<a href="Structs/Count.html">Count</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Generics.html">Generics</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/GenericAttribute.html">GenericAttribute</a>
</li>
<li class="nav-group-task">
<a href="Protocols/GenericAttributeType.html">GenericAttributeType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Deprecated.html">Deprecated</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Deprecated.html#/s:11SwiftyMocky14VerifyProperty__4file4lineyx_0C0Qzs12StaticStringVSutAA4MockRzlF">VerifyProperty(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Deprecated.html#/s:11SwiftyMocky14VerifyProperty__4file4lineyxm_06StaticC0Qzs0G6StringVSutAA0G4MockRzlF">VerifyProperty(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Deprecated.html#/s:11SwiftyMocky14VerifyProperty___4file4lineyx_AA5CountV0C0Qzs12StaticStringVSutAA4MockRzlF">VerifyProperty(_:_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Deprecated.html#/s:11SwiftyMocky14VerifyProperty___4file4lineyxm_AA5CountV06StaticC0Qzs0H6StringVSutAA0H4MockRzlF">VerifyProperty(_:_:_:file:line:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Guides.html">Other Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="contents.html">Contents</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Classes.html">Other Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/StubbedMethod.html">StubbedMethod</a>
</li>
<li class="nav-group-task">
<a href="Classes/SwiftyMockyTestObserver.html">SwiftyMockyTestObserver</a>
</li>
<li class="nav-group-task">
<a href="Classes/SwiftyMockyTestObserver.html">SwiftyMockyTestObserver</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Other Enums.html#/s:11SwiftyMocky9MockErrorO">MockError</a>
</li>
<li class="nav-group-task">
<a href="Enums/Product.html">Product</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Extensions.html">Other Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UInt.html">UInt</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Functions.html">Other Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Other Functions.html#/s:11SwiftyMocky7Failureys5NeverOSSF">Failure(_:)</a>
</li>
<li class="nav-group-task">
<a href="Other Functions.html#/s:11SwiftyMocky20XCTAssertThrowsError_5error_4file4lineyxyKXK_q_SSyXKs12StaticStringVSutSQR_s0E0R_r0_lF">XCTAssertThrowsError(_:error:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Other Functions.html#/s:11SwiftyMocky20XCTAssertThrowsError_2of_4file4lineyxyKXK_q_mSSyXKs12StaticStringVSuts0E0R_r0_lF">XCTAssertThrowsError(_:of:_:file:line:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/WithSequencingPolicy.html">WithSequencingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Protocols/WithStaticSequencingPolicy.html">WithStaticSequencingPolicy</a>
</li>
<li class="nav-group-task">
<a href="Protocols/WithStubbingPolicy.html">WithStubbingPolicy</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Other Structs.html">Other Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/FatalErrorUtil.html">FatalErrorUtil</a>
</li>
<li class="nav-group-task">
<a href="Structs/Stubber.html">Stubber</a>
</li>
<li class="nav-group-task">
<a href="Structs/StubberThrows.html">StubberThrows</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Configuration</h1>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Stubbing%20Policy"></a>
<a name="//apple_ref/swift/Section/Stubbing Policy" class="dashAnchor"></a>
<a href="#/Stubbing%20Policy">
<h3 class="section-name">Stubbing Policy</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky14StubbingPolicyO"></a>
<a name="//apple_ref/swift/Enum/StubbingPolicy" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky14StubbingPolicyO">StubbingPolicy</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Given Policy for treating sequence of events (products). Used to determine if stub return values should be consumed
once (.drop), or reused (.wrap). Applies to sequence as well - .drop means remove from stack after using, while
.wrap iterates over sequence indefinitely.</p>
<ul>
<li><code>default</code>: Use current policy specified for Mock method type</li>
<li><code>wrap</code>: Default policy in general. When reaching end of sequence of events, index will rewind to beginning (looping)</li>
<li><code>drop</code>: With this policy, every call drops event. When events count reaches zero, given is removed from mock.</li>
</ul>
<a href="Enums/StubbingPolicy.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StubbingPolicy</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Sequencing%20policy"></a>
<a name="//apple_ref/swift/Section/Sequencing policy" class="dashAnchor"></a>
<a href="#/Sequencing%20policy">
<h3 class="section-name">Sequencing policy</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky16SequencingPolicyO"></a>
<a name="//apple_ref/swift/Enum/SequencingPolicy" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky16SequencingPolicyO">SequencingPolicy</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sequencing policy - in which order Given would be resolved. Pleas ehve in mind that this policy is applied ONLY after
first ordering (based on how explicit is stub) is done.</p>
<ul>
<li><code>lastWrittenResolvedFirst</code>: Default policy. Last given overrides previous, if they are both with same generocity level</li>
<li><code>inWritingOrder</code>: Givens would be recalled in order of generocity, respecting writing order (first line resolved first)</li>
</ul>
<a href="Enums/SequencingPolicy.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SequencingPolicy</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>Copyright © 2017 MakeAWishFoundation. All rights reserved.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>