Gitiles
Code Review Sign In
android-review.linaro.org / platform / tools / dokka-devsite-plugin / 6f896de9f93fe82ff1c7f1a7d1ff5c994d9503b9 / . / testData / linking / docs / reference / kotlin / dokkatest / linking / JavaEnum.html
blob: 1534b49ebf84c9931164a97c2ca5f5b89cf4474f [file] [log] [blame]
<html devsite="true">
<head>
<title>JavaEnum</title>
{% setvar book_path %}/reference/kotlin/dokkatest/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>JavaEnum</h1>
<p>
<pre>enum <a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a></pre>
</p>
<hr>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Enum Values</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#ON_DECEIT">ON_DECEIT</a></code></td>
<td></td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#ON_DESTROY">ON_DESTROY</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#JavaEnum()">JavaEnum</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>java-static <a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!</code></td>
<td>
<div><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#valueOf(java.lang.String)">valueOf</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!)</code></div>
<p>Returns the enum constant of this type with the specified name.</p>
</td>
</tr>
<tr>
<td width="40%"><code>java-static <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!&gt;!</code></td>
<td>
<div><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#values()">values</a>()</code></div>
<p>Returns an array containing the constants of this enum type, in the order they're declared.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Enum Values</h2>
<div>
<h3 class="api-name" id="ON_DECEIT">ON_DECEIT</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#ON_DECEIT">JavaEnum.ON_DECEIT</a>:&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a></pre>
</div>
<div>
<h3 class="api-name" id="ON_DESTROY">ON_DESTROY</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#ON_DESTROY">JavaEnum.ON_DESTROY</a>:&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a></pre>
</div>
<h2>Public constructors</h2>
<div><a name="JavaEnum--"></a><a name="javaenum"></a>
<h3 class="api-name" id="JavaEnum()">JavaEnum</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#JavaEnum()">JavaEnum</a>()</pre>
</div>
<h2>Public functions</h2>
<div><a name="valueOf-java.lang.String-"></a><a name="valueof"></a>
<h3 class="api-name" id="valueOf(java.lang.String)">valueOf</h3>
<pre class="api-signature no-pretty-print">java-static&nbsp;fun&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#valueOf(java.lang.String)">valueOf</a>(name:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>!):&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!</pre>
<p>Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!</code></td>
<td>
<p>the enum constant with the specified name</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Throws</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>java.lang.IllegalArgumentException:&nbsp;<a href="https://developer.android.com/reference/java/lang/IllegalArgumentException.html">java.lang.IllegalArgumentException</a></code></td>
<td>
<p>if this enum type has no constant with the specified name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="values--"></a><a name="values"></a>
<h3 class="api-name" id="values()">values</h3>
<pre class="api-signature no-pretty-print">java-static&nbsp;fun&nbsp;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html#values()">values</a>():&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!&gt;!</pre>
<p>Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a>&lt;<a href="/reference/kotlin/dokkatest/linking/JavaEnum.html">JavaEnum</a>!&gt;!</code></td>
<td>
<p>an array containing the constants of this enum type, in the order they're declared</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>