| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>Workaround (Apache SIS 1.4 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.util, package: org.apache.sis.util, annotation type: Workaround"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.util.Workaround class"> |
| <meta name="keywords" content="library()"> |
| <meta name="keywords" content="version()"> |
| <meta name="keywords" content="fixed()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><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 class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Summary:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#annotation-interface-required-element-summary">Required</a></li> |
| <li><a href="#annotation-interface-optional-element-summary">Optional</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Detail:</p> |
| <ul> |
| <li>Field</li> |
| <li><a href="#annotation-interface-element-detail">Element</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Field | </li> |
| <li><a href="#annotation-interface-required-element-summary">Required</a> | </li> |
| <li><a href="#annotation-interface-optional-element-summary">Optional</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation-interface-element-detail">Element</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.util</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.util</a></div> |
| <h1 title="Annotation Interface Workaround" class="title">Annotation Interface Workaround</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a> |
| <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/docs/api/java.base/java/lang/annotation/ElementType.html#CONSTRUCTOR" title="class or interface in java.lang.annotation" class="external-link">CONSTRUCTOR</a>,<a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/annotation/ElementType.html#FIELD" title="class or interface in java.lang.annotation" class="external-link">FIELD</a>,<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/annotation/ElementType.html#LOCAL_VARIABLE" title="class or interface in java.lang.annotation" class="external-link">LOCAL_VARIABLE</a>}) |
| <a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#SOURCE" title="class or interface in java.lang.annotation" class="external-link">SOURCE</a>) |
| </span><span class="modifiers">public @interface </span><span class="element-name type-name-label">Workaround</span></div> |
| <div class="block">Annotates code containing workarounds for bugs or limitations in an external library. |
| This is marker annotation for source code only, in order to keep trace of code to revisit |
| when new versions of external libraries become available. |
| |
| <h2 id="usage-note-heading">Usage note</h2> |
| When only a portion of a method contains a workaround and the annotation cannot be applied to that specific part, |
| then it is applied to the whole method. Developers need to refer to code comments in order to locate the specific |
| part.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY =========== --> |
| <li> |
| <section class="member-summary" id="annotation-interface-required-element-summary"> |
| <h2>Required Element Summary</h2> |
| <div class="caption"><span>Required Elements</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Required Element</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#library()" class="member-name-link">library</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A string identifying the library having a bug or limitation.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#version()" class="member-name-link">version</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The last library version on which the bug has been verified.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== ANNOTATION INTERFACE OPTIONAL MEMBER SUMMARY =========== --> |
| <li> |
| <section class="member-summary" id="annotation-interface-optional-element-summary"> |
| <h2>Optional Element Summary</h2> |
| <div class="caption"><span>Optional Elements</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Optional Element</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#fixed()" class="member-name-link">fixed</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">If the bug has been fixed, the version on which the fix has been applied.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details" id="annotation-interface-element-detail"> |
| <ul class="details-list"> |
| <!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== --> |
| <li> |
| <section class="member-details"> |
| <h2>Element Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="library()"> |
| <h3>library</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">library</span></div> |
| <div class="block">A string identifying the library having a bug or limitation. |
| Examples: <code>"JDK"</code>, <code>"NetCDF"</code>, <code>"JUnit"</code>, <code>"SIS"</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an identifier of the library having a bug or limitation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="version()"> |
| <h3>version</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">version</span></div> |
| <div class="block">The last library version on which the bug has been verified. |
| The bug may have existed before, and may still exist later.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the library version on which the bug has been observed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fixed()"> |
| <h3>fixed</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">fixed</span></div> |
| <div class="block">If the bug has been fixed, the version on which the fix has been applied. |
| Otherwise an empty string.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the library version on which the fix has been applied.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Default:</dt> |
| <dd><code>""</code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
