blob: 3428d76283e48734771dec54ff7fa8255f62dc50 [file] [log] [blame]
<!doctype html>
<!-- Generated by FreeMarker/Docgen from DocBook -->
<html lang="en" class="page-type-section">
<head prefix="og: http://ogp.me/ns#">
<meta charset="utf-8">
<title>switch, case, default, break - FreeMarker Manual</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="format-detection" content="telephone=no">
<meta property="og:site_name" content="FreeMarker Manual">
<meta property="og:title" content="switch, case, default, break">
<meta property="og:locale" content="en_US">
<meta property="og:url" content="http://example.com/ref_directive_switch.html">
<link rel="canonical" href="http://example.com/ref_directive_switch.html">
<link rel="icon" href="favicon.png" type="image/png">
<link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338519184">
</head>
<body itemscope itemtype="https://schema.org/Code">
<meta itemprop="url" content="http://example.com/">
<meta itemprop="name" content="FreeMarker Manual">
<!--[if lte IE 9]>
<div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div>
<![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo">
</a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref.html"><span itemprop="name">Reference</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_directives.html"><span itemprop="name">Directive Reference</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_directive_switch.html"><span itemprop="name">switch, case, default, break</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li><li><a href="api/index.html">API</a></li><li><a href="../index.html">Home</a></li></ul></div></div></div> <div class="main-content site-width">
<div class="content-wrapper">
<div id="table-of-contents-wrapper" class="col-left">
<script>var breadcrumb = ["FreeMarker Manual","Reference","Directive Reference","switch, case, default, break"];</script>
<script src="toc.js?1594338519184"></script>
<script src="docgen-resources/main.min.js?1594338519184"></script>
</div>
<div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="ref_directive_if.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_list.html"><span>Next</span></a></div><div class="title-wrapper">
<h1 class="content-header header-section1" id="ref_directive_switch" itemprop="headline">switch, case, default, break</h1>
</div></div><div class="page-menu">
<div class="page-menu-title">Page Contents</div>
<ul><li><a class="page-menu-link" href="#autoid_80" data-menu-target="autoid_80">Synopsis</a></li><li><a class="page-menu-link" href="#autoid_81" data-menu-target="autoid_81">Description</a></li></ul> </div><a name="ref.directive.switch"></a><a name="ref.directive.case"></a><a name="ref.directive.default"></a><a name="ref.directive.switch.break"></a>
<h2 class="content-header header-section2" id="autoid_80">Synopsis</h2>
<pre class="metaTemplate">
<code class="inline-code">&lt;#switch <em class="code-color">value</em>&gt;
&lt;#case <em class="code-color">refValue1</em>&gt;
<em class="code-color">...</em>
&lt;#break&gt;
&lt;#case <em class="code-color">refValue2</em>&gt;
<em class="code-color">...</em>
&lt;#break&gt;
<em class="code-color">...</em>
&lt;#case <em class="code-color">refValueN</em>&gt;
<em class="code-color">...</em>
&lt;#break&gt;
&lt;#default&gt;
<em class="code-color">...</em>
&lt;/#switch&gt;
</code>
</pre>
<p>Where:</p>
<ul>
<li>
<code class="inline-code"><em class="code-color">value</em></code>,
<code class="inline-code"><em class="code-color">refValue1</em></code>, etc.:
Expressions evaluates to scalars of the same type.
</li>
</ul>
<h2 class="content-header header-section2" id="autoid_81">Description</h2>
<p>The usage of this directive is not recommended, as it is
error-prone because of the fall-through behavior. Use <a href="ref_directive_if.html#ref.directive.elseif"><code>elseif</code></a>-s
instead unless you want to exploit the fall-through behavior.</p>
<p>Switch is used to choose a fragment of template depending on
the value of an expression:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#switch being.size&gt;
&lt;#case &quot;small&quot;&gt;
This will be processed if it is small
&lt;#break&gt;
&lt;#case &quot;medium&quot;&gt;
This will be processed if it is medium
&lt;#break&gt;
&lt;#case &quot;large&quot;&gt;
This will be processed if it is large
&lt;#break&gt;
&lt;#default&gt;
This will be processed if it is neither
&lt;/#switch&gt;</pre></div>
<p>Inside the <code class="inline-code">switch</code> must be one or more
<code class="inline-code">&lt;#case <em class="code-color">value</em>&gt;</code>,
and after all such <code class="inline-code">case</code> tags optionally one
<code class="inline-code">&lt;#default&gt;</code>. When FM reaches the
<code class="inline-code">switch</code> directive, it chooses a
<code class="inline-code">case</code> directive where
<code class="inline-code"><em class="code-color">refValue</em></code> equals with
<code class="inline-code"><em class="code-color">value</em></code> and continues
the processing of the template there. If there is no
<code class="inline-code">case</code> directive with appropriate value then it
continues processing at the <code class="inline-code">default</code> directive if
that exists, otherwise it continues the processing after the end-tag
of <code class="inline-code">switch</code>. And now comes the confusing thing:
when it has chosen a <code class="inline-code">case</code> directive, it will
continue the processing there, and will go ahead until it reaches a
<code class="inline-code">break</code> directive. That is, it will not
automatically leave the <code class="inline-code">switch</code> directive when it
reaches another <code class="inline-code">case</code> directive or the
<code class="inline-code">&lt;#default&gt;</code> tag. Example:</p>
<div class="code-wrapper"><pre class="code-block code-template">&lt;#switch x&gt;
&lt;#case x = 1&gt;
1
&lt;#case x = 2&gt;
2
&lt;#default&gt;
d
&lt;/#switch&gt;</pre></div>
<p>If <code class="inline-code">x</code> is 1, then it will print 1 2 d; if
<code class="inline-code">x</code> is 2 then it will print 2 d; if
<code class="inline-code">x</code> is 3 then it will print d. This is the
mentioned fall-through behavior. The <code class="inline-code">break</code> tag
instructs FM to immediately skip past the <code class="inline-code">switch</code>
end-tag.</p>
<div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="ref_directive_if.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_directive_list.html"><span>Next</span></a></div></div></div></div> </div>
</div>
<div class="site-footer"><div class="site-width"><div class="footer-top"><div class="col-left sitemap"></div><div class="col-right"><a class="xxe" href="http://www.xmlmind.com/xmleditor/" rel="nofollow" title="Edited with XMLMind XML Editor"><span>Edited with XMLMind XML Editor</span></a></div></div><div class="footer-bottom"> <p class="last-generated">
Last generated:
<time itemprop="dateModified" datetime="2020-07-09T23:48:39Z" title="Thursday, July 9, 2020 11:48:39 PM GMT">2020-07-09 23:48:39 GMT</time> </p>
<p class="copyright">
© <span itemprop="copyrightYear">1999</span>–2020
<a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p>
</div></div></div></body>
</html>