Google Git
Sign in
android/platform/tools/dokka-devsite-plugin/0a4e539cb5607c306e3ffe51b616f4e6601a4bc3/./testData/annotation-kmp/docs/reference/androidx/annotation/InspectableProperty.FlagEntry.html
blob: fe99604fbd9198c3355978dad3d584503041ca4c [file]
<html devsite="true">
<head>
<title>InspectableProperty.FlagEntry</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div itemscope="" itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="InspectableProperty.FlagEntry">
<meta itemprop="path" content="androidx.annotation">
<meta itemprop="property" content="getMask()">
<meta itemprop="property" content="getName()">
<meta itemprop="property" content="getTarget()">
<meta itemprop="language" content="JAVA">
</div>
<div id="header-block">
<div>
<h1>InspectableProperty.FlagEntry</h1>
</div>
<div id="metadata-info-block">
<div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/annotation/InspectableProperty.kt+class:androidx.annotation.InspectableProperty.FlagEntry&amp;ss=androidx/platform/frameworks/support" class="external">View Source</a></div>
</div>
</div>
<div id="refdoc-switcher-placeholder"></div>
<p>
<pre>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html">Target</a>(allowedTargets&nbsp;=&nbsp;[AnnotationTarget.ANNOTATION_CLASS,&nbsp;AnnotationTarget.CLASS])<br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-retention/index.html">Retention</a>(value&nbsp;=&nbsp;AnnotationRetention.SOURCE)<br>public annotation <a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html">InspectableProperty.FlagEntry</a></pre>
</p>
<hr>
<p>One flag value of many that may be packed into a primitive {int}.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#FlagEntry(kotlin.String,kotlin.Int,kotlin.Int)">FlagEntry</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;name,&nbsp;int&nbsp;target,&nbsp;int&nbsp;mask)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getMask()">getMask</a>()</code></div>
<p>A mask that the property will be bitwise anded with before comparing to the target.</p>
</td>
</tr>
<tr>
<td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td>
<div><code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getName()">getName</a>()</code></div>
<p>The string name of this flag.</p>
</td>
</tr>
<tr>
<td><code>final int</code></td>
<td>
<div><code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getTarget()">getTarget</a>()</code></div>
<p>A target value that the property's value must equal after masking.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="FlagEntry(kotlin.String, kotlin.Int, kotlin.Int)"></a><a name="FlagEntry-kotlin.String-kotlin.Int-kotlin.Int-"></a><a name="flagentry"></a>
<div class="api-name-block">
<div>
<h3 id="FlagEntry(kotlin.String,kotlin.Int,kotlin.Int)">FlagEntry</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;<a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#FlagEntry(kotlin.String,kotlin.Int,kotlin.Int)">FlagEntry</a>(@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;name,&nbsp;int&nbsp;target,&nbsp;int&nbsp;mask)</pre>
</div>
</div>
<div class="list">
<h2>Public methods</h2>
<div class="api-item"><a name="getMask--"></a><a name="getmask"></a>
<div class="api-name-block">
<div>
<h3 id="getMask()">getMask</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getMask()">getMask</a>()</pre>
<p>A mask that the property will be bitwise anded with before comparing to the target.</p>
<p>If set to 0 (the default), the value of <code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#target()">target</a></code> will be used as a mask. Zero was chosen as the default since bitwise and with zero is always zero.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>int</code></td>
<td>
<p>A mask, or 0 to use the target as a mask</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="getName--"></a><a name="getname"></a>
<div class="api-name-block">
<div>
<h3 id="getName()">getName</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a>&nbsp;<a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getName()">getName</a>()</pre>
<p>The string name of this flag.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>@<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/java/lang/String.html">String</a></code></td>
<td>
<p>A string name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="api-item"><a name="getTarget--"></a><a name="gettarget"></a>
<div class="api-name-block">
<div>
<h3 id="getTarget()">getTarget</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#getTarget()">getTarget</a>()</pre>
<p>A target value that the property's value must equal after masking.</p>
<p>If a mask is not supplied (i.e., <code><a href="/reference/androidx/annotation/InspectableProperty.FlagEntry.html#mask()">mask</a></code> is 0), the target will be reused as the mask. This handles the common case where no flags mutually exclude each other.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Returns</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>int</code></td>
<td>
<p>The target value to compare against</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>