| <html devsite="true"> |
| <head> |
| <title>IntDef</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="IntDef"> |
| <meta itemprop="path" content="androidx.annotation"> |
| <meta itemprop="property" content="getFlag()"> |
| <meta itemprop="property" content="getOpen()"> |
| <meta itemprop="property" content="getValue()"> |
| <meta itemprop="language" content="JAVA"> |
| </div> |
| <div id="header-block"> |
| <div> |
| <h1>IntDef</h1> |
| </div> |
| <div id="metadata-info-block"> |
| <div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/annotation/IntDef.kt+class:androidx.annotation.IntDef&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/-retention/index.html">Retention</a>(value = AnnotationRetention.SOURCE)<br>@<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html">Target</a>(allowedTargets = [AnnotationTarget.ANNOTATION_CLASS])<br>public annotation <a href="/reference/androidx/annotation/IntDef.html">IntDef</a></pre> |
| </p> |
| <hr> |
| <p>Denotes that the annotated element of integer type, represents a logical type and that its value should be one of the explicitly named constants. If the IntDef#flag() attribute is set to true, multiple constants can be combined.</p> |
| <p>Example:</p> |
| <pre class="prettyprint">@Retention(SOURCE)<br>@IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})<br>public @interface NavigationMode {}<br>public static final int NAVIGATION_MODE_STANDARD = 0;<br>public static final int NAVIGATION_MODE_LIST = 1;<br>public static final int NAVIGATION_MODE_TABS = 2;<br>...<br>public abstract void setNavigationMode(@NavigationMode int mode);<br><br>@NavigationMode<br>public abstract int getNavigationMode();</pre> |
| <p>For a flag, set the flag attribute:</p> |
| <pre class="prettyprint">@IntDef(<br>flag = true,<br>value = {NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS}<br>)</pre> |
| <div class="devsite-table-wrapper"> |
| <table class="responsive"> |
| <colgroup> |
| <col width="40%"> |
| <col> |
| </colgroup> |
| <thead> |
| <tr> |
| <th colspan="100%">See also</th> |
| </tr> |
| </thead> |
| <tbody class="list"> |
| <tr> |
| <td><code><a href="/reference/androidx/annotation/LongDef.html">LongDef</a></code></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <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/IntDef.html#IntDef(kotlin.IntArray,kotlin.Boolean,kotlin.Boolean)">IntDef</a>(int value, boolean flag, boolean open)</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 boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/annotation/IntDef.html#getFlag()">getFlag</a>()</code></div> |
| <p>Defines whether the constants can be used as a flag, or just as an enum (the default)</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>final boolean</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/annotation/IntDef.html#getOpen()">getOpen</a>()</code></div> |
| <p>Whether any other values are allowed.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code>final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[]</code></td> |
| <td> |
| <div><code><a href="/reference/androidx/annotation/IntDef.html#getValue()">getValue</a>()</code></div> |
| <p>Defines the allowed constants for this element</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="list"> |
| <h2>Public constructors</h2> |
| <div class="api-item"><a name="IntDef(kotlin.IntArray, kotlin.Boolean, kotlin.Boolean)"></a><a name="IntDef-kotlin.IntArray-kotlin.Boolean-kotlin.Boolean-"></a><a name="intdef"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="IntDef(kotlin.IntArray,kotlin.Boolean,kotlin.Boolean)">IntDef</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public <a href="/reference/androidx/annotation/IntDef.html#IntDef(kotlin.IntArray,kotlin.Boolean,kotlin.Boolean)">IntDef</a>(int value, boolean flag, boolean open)</pre> |
| </div> |
| </div> |
| <div class="list"> |
| <h2>Public methods</h2> |
| <div class="api-item"><a name="getFlag--"></a><a name="getflag"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="getFlag()">getFlag</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public final boolean <a href="/reference/androidx/annotation/IntDef.html#getFlag()">getFlag</a>()</pre> |
| <p>Defines whether the constants can be used as a flag, or just as an enum (the default)</p> |
| </div> |
| <div class="api-item"><a name="getOpen--"></a><a name="getopen"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="getOpen()">getOpen</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public final boolean <a href="/reference/androidx/annotation/IntDef.html#getOpen()">getOpen</a>()</pre> |
| <p>Whether any other values are allowed. Normally this is not the case, but this allows you to specify a set of expected constants, which helps code completion in the IDE and documentation generation and so on, but without flagging compilation warnings if other values are specified.</p> |
| </div> |
| <div class="api-item"><a name="getValue--"></a><a name="getvalue"></a> |
| <div class="api-name-block"> |
| <div> |
| <h3 id="getValue()">getValue</h3> |
| </div> |
| </div> |
| <pre class="api-signature no-pretty-print">public final @<a href="/reference/androidx/annotation/NonNull.html">NonNull</a> int[] <a href="/reference/androidx/annotation/IntDef.html#getValue()">getValue</a>()</pre> |
| <p>Defines the allowed constants for this element</p> |
| </div> |
| </div> |
| </body> |
| </html> |
