blob: d28a4dd7954c123eb2e3361fa4e58f244b113035 [file] [log] [blame]
<html devsite="true">
<head>
<title>ViewDebug.FlagToString</title>
{% setvar book_path %}/reference/dokkatest/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>ViewDebug.FlagToString</h1>
<p>
<pre>@<a href="https://developer.android.com/reference/java/lang/annotation/Target.html">Target</a>(value&nbsp;=&nbsp;[ElementType.TYPE])<br>@<a href="https://developer.android.com/reference/java/lang/annotation/Retention.html">Retention</a>(value&nbsp;=&nbsp;RetentionPolicy.RUNTIME)<br>public annotation <a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html">ViewDebug.FlagToString</a></pre>
</p>
<hr>
<p>Defines a mapping from a flag to a String. Such a mapping can be used in an @ExportedProperty to provide more meaningful values to the end user.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%">See also</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code><a href="https://developer.android.com/reference/android/view/ViewDebug.ExportedProperty.html">ViewDebug.ExportedProperty</a></code></td>
<td></td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td width="40%"><code>abstract int</code></td>
<td>
<div><code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#equals()">equals</a>()</code></div>
<p>The value to compare to the result of: <code>original value &amp; <code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#mask()">mask</a></code></code>.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract int</code></td>
<td>
<div><code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#mask()">mask</a>()</code></div>
<p>The mask to apply to the original value.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td>
<div><code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#name()">name</a>()</code></div>
<p>The String to use in place of the original int value.</p>
</td>
</tr>
<tr>
<td width="40%"><code>abstract boolean</code></td>
<td>
<div><code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#outputIf()">outputIf</a>()</code></div>
<p>Indicates whether to output the flag when the test is true, or false.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public methods</h2>
<div><a name="equals--"></a><a name="equals"></a>
<h3 class="api-name" id="equals()">equals</h3>
<pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;int&nbsp;<a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#equals()">equals</a>()</pre>
<p>The value to compare to the result of: <code>original value &amp; <code><a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#mask()">mask</a></code></code>.</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>int</code></td>
<td>
<p>An arbitrary value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="mask--"></a><a name="mask"></a>
<h3 class="api-name" id="mask()">mask</h3>
<pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;int&nbsp;<a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#mask()">mask</a>()</pre>
<p>The mask to apply to the original value.</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>int</code></td>
<td>
<p>An arbitrary int value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="name--"></a><a name="name"></a>
<h3 class="api-name" id="name()">name</h3>
<pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;<a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;<a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#name()">name</a>()</pre>
<p>The String to use in place of the original int value.</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://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td>
<p>An arbitrary non-null String.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="outputIf--"></a><a name="outputif"></a>
<h3 class="api-name" id="outputIf()">outputIf</h3>
<pre class="api-signature no-pretty-print">public&nbsp;abstract&nbsp;boolean&nbsp;<a href="/reference/dokkatest/platform/ViewDebug.FlagToString.html#outputIf()">outputIf</a>()</pre>
<p>Indicates whether to output the flag when the test is true, or false. Defaults to true.</p>
</div>
</body>
</html>