|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (25) on Tue Jun 30 17:22:35 UTC 2026 --> |
| 5 | +<title>AllowCopilotExperimental (GitHub Copilot SDK for Java — Documentation Site java/v1.0.5 API)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 8 | +<meta name="dc.created" content="2026-06-30"> |
| 9 | +<meta name="description" content="declaration: module: com.github.copilot.java, package: com.github.copilot, annotation type: AllowCopilotExperimental"> |
| 10 | +<meta name="generator" content="javadoc/ClassWriter"> |
| 11 | +<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css"> |
| 12 | +<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css"> |
| 13 | +<script type="text/javascript" src="../../../../script-files/script.js"></script> |
| 14 | +<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> |
| 15 | +<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> |
| 16 | +</head> |
| 17 | +<body class="class-declaration-page"> |
| 18 | +<script type="text/javascript">const pathtoroot = "../../../../"; |
| 19 | +loadScripts(document, 'script');</script> |
| 20 | +<noscript> |
| 21 | +<div>JavaScript is disabled on your browser.</div> |
| 22 | +</noscript> |
| 23 | +<header role="banner"> |
| 24 | +<nav role="navigation"> |
| 25 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 26 | +<div class="top-nav" id="navbar-top"> |
| 27 | +<div class="nav-content"> |
| 28 | +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| 29 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 30 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 31 | +<li><a href="../../../module-summary.html">Module</a></li> |
| 32 | +<li class="nav-bar-cell1-rev">Class</li> |
| 33 | +<li><a href="class-use/AllowCopilotExperimental.html">Use</a></li> |
| 34 | +<li><a href="package-tree.html">Tree</a></li> |
| 35 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 36 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 37 | +<li><a href="../../../../search.html">Search</a></li> |
| 38 | +<li><a href="../../../../help-doc.html#class">Help</a></li> |
| 39 | +</ul> |
| 40 | +</div> |
| 41 | +</div> |
| 42 | +<div class="sub-nav"> |
| 43 | +<div class="nav-content"> |
| 44 | +<ol class="sub-nav-list"> |
| 45 | +<li><a href="../../../module-summary.html">com.github.copilot.java</a></li> |
| 46 | +<li><a href="package-summary.html">com.github.copilot</a></li> |
| 47 | +<li><a href="AllowCopilotExperimental.html" class="current-selection">AllowCopilotExperimental</a></li> |
| 48 | +</ol> |
| 49 | +<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| 50 | +</div> |
| 51 | +</div> |
| 52 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 53 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 54 | +</header> |
| 55 | +<div class="main-grid"> |
| 56 | +<nav role="navigation" class="toc" aria-label="Table of contents"> |
| 57 | +<div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div> |
| 58 | +<ol class="toc-list" tabindex="-1"> |
| 59 | +<li><a href="#" tabindex="0">Description</a></li> |
| 60 | +</ol> |
| 61 | +<button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav> |
| 62 | +<main role="main"> |
| 63 | +<!-- ======== START OF CLASS DATA ======== --> |
| 64 | +<div class="header"> |
| 65 | +<h1 title="Annotation Interface AllowCopilotExperimental" class="title">Annotation Interface AllowCopilotExperimental</h1> |
| 66 | +</div> |
| 67 | +<section class="class-description" id="class-description"> |
| 68 | +<hr> |
| 69 | +<div class="horizontal-scroll"> |
| 70 | +<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a> |
| 71 | +<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#CLASS" title="class or interface in java.lang.annotation" class="external-link">CLASS</a>) |
| 72 | +<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>({<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>,<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>,<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/annotation/ElementType.html#CONSTRUCTOR" title="class or interface in java.lang.annotation" class="external-link">CONSTRUCTOR</a>}) |
| 73 | +</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">AllowCopilotExperimental</span></div> |
| 74 | +<div class="block">Opts a declaration into using <a href="CopilotExperimental.html" title="annotation interface in com.github.copilot"><code>CopilotExperimental</code></a> APIs. |
| 75 | + |
| 76 | +<p> |
| 77 | +Apply this annotation to a type to allow declaration-level references to |
| 78 | +experimental APIs anywhere within that type, or apply it to a method or |
| 79 | +constructor to allow experimental API usage in that executable's signature. |
| 80 | +This is a code-level alternative to the compiler option |
| 81 | +<code>-Acopilot.experimental.allowed=true</code>. |
| 82 | + |
| 83 | +<p> |
| 84 | +This opt-in has the same declaration-level scope as the processor itself. It |
| 85 | +does not affect expression-only usages inside method bodies that are not |
| 86 | +visible to standard JSR 269 annotation processing.</div> |
| 87 | +<dl class="notes"> |
| 88 | +<dt>Since:</dt> |
| 89 | +<dd>1.0.0</dd> |
| 90 | +</dl> |
| 91 | +</div> |
| 92 | +</section> |
| 93 | +<section class="details" id="annotation-interface-element-detail"></section> |
| 94 | +<!-- ========= END OF CLASS DATA ========= --> |
| 95 | +<footer role="contentinfo"> |
| 96 | +<hr> |
| 97 | +<p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p> |
| 98 | +</footer> |
| 99 | +</main> |
| 100 | +</div> |
| 101 | +</body> |
| 102 | +</html> |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments