<!DOCTYPE html>
<html lang="en">
<head>
<title>StaticMock Protocol 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/Protocol/StaticMock" class="dashAnchor"></a>
<a title="StaticMock Protocol 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" />
StaticMock Protocol 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>StaticMock</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">StaticMock</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div>
</div>
<p>Every mock, that stubs static methods, should adopt <strong>StaticMock</strong> protocol.
It defines base StaticMock structure and features.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP0C5GivenQa"></a>
<a name="//apple_ref/swift/Alias/StaticGiven" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP0C5GivenQa">StaticGiven</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Stubbed method and property type</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">StaticGiven</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP0C6VerifyQa"></a>
<a name="//apple_ref/swift/Alias/StaticVerify" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP0C6VerifyQa">StaticVerify</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Verification type</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">StaticVerify</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP0C7PerformQa"></a>
<a name="//apple_ref/swift/Alias/StaticPerform" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP0C7PerformQa">StaticPerform</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Perform type</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">associatedtype</span> <span class="kt">StaticPerform</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP5clearyyFZ"></a>
<a name="//apple_ref/swift/Method/clear()" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP5clearyyFZ">clear()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>As verifying static members relies on static count of invocations, clear allows to ‘reset’ static mock internals.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">clear</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP5givenyy0C5GivenQzFZ"></a>
<a name="//apple_ref/swift/Method/given(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP5givenyy0C5GivenQzFZ">given(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Registers return value for stubbed method, for specified attributes set.</p>
<p>When this method will be called on mock, it will check for first matching given, with following rules:</p>
<ol>
<li>First check most specific givens (with explicit parameters - .value), then for wildcard parameters (.any)</li>
<li>More recent givens have higher priority than older ones</li>
<li>When two given’s have same level of explicity, like:
<code>
Given(mock, .do(with: .value(1), and: .any)
Given(mock, .do(with: .any, and: .value(1))
</code>
Method stub will return most recent one.</li>
</ol>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">given</span><span class="p">(</span><span class="n">_</span> <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Protocols/StaticMock.html#/s:11SwiftyMocky10StaticMockP0C5GivenQa">StaticGiven</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>method</em>
</code>
</td>
<td>
<div>
<p>signature, with attributes (any or explicit value). Type <code>.</code> for all available</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP7performyy0C7PerformQzFZ"></a>
<a name="//apple_ref/swift/Method/perform(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP7performyy0C7PerformQzFZ">perform(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Registers perform closure, which will be executed upon calling stubbed method, for specified attribtes.</p>
<p>When this method will be called on mock, it
will check for first matching closure and execute it with parameters passed. Have in mind following rules:</p>
<ol>
<li>First check most specific performs (with explicit parameters - .value), then for wildcard parameters (.any)</li>
<li>More recent performs have higher priority than older ones</li>
<li>When two performs have same level of explicity, like:
<code>
Perform(mock, .do(with: .value(1), and: .any, perform: { ... }))
Perform(mock, .do(with: .any, and: .value(1), perform: { ... }))
</code>
Method stub will return most recent one.</li>
</ol>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">perform</span><span class="p">(</span><span class="n">_</span> <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Protocols/StaticMock.html#/s:11SwiftyMocky10StaticMockP0C7PerformQa">StaticPerform</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>method</em>
</code>
</td>
<td>
<div>
<p>signature, with attributes (any or explicit value). Type <code>.</code> for all available</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11SwiftyMocky10StaticMockP6verify_5count4file4liney0C6VerifyQz_AA5CountVs0C6StringVSutFZ"></a>
<a name="//apple_ref/swift/Method/verify(_:count:file:line:)" class="dashAnchor"></a>
<a class="token" href="#/s:11SwiftyMocky10StaticMockP6verify_5count4file4liney0C6VerifyQz_AA5CountVs0C6StringVSutFZ">verify(_:count:file:line:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Verifies, that given method stub was called exact number of times.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">static</span> <span class="kd">func</span> <span class="nf">verify</span><span class="p">(</span><span class="n">_</span> <span class="nv">method</span><span class="p">:</span> <span class="kt"><a href="../Protocols/StaticMock.html#/s:11SwiftyMocky10StaticMockP0C6VerifyQa">StaticVerify</a></span><span class="p">,</span> <span class="nv">count</span><span class="p">:</span> <span class="kt"><a href="../Structs/Count.html">Count</a></span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">StaticString</span><span class="p">,</span> <span class="nv">line</span><span class="p">:</span> <span class="kt">UInt</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>method</em>
</code>
</td>
<td>
<div>
<p>Method signature with wrapped parameters (Parameter<ValueType>)</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>count</em>
</code>
</td>
<td>
<div>
<p>Number of invocations</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>file</em>
</code>
</td>
<td>
<div>
<p>for XCTest print purposes</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>line</em>
</code>
</td>
<td>
<div>
<p>for XCTest print purposes</p>
</div>
</td>
</tr>
</tbody>
</table>
</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>