docs/2.3.3/apidocs/opennlp-tools/opennlp/tools/commons/ThreadSafe.html - opennlp-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="de">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>ThreadSafe (Apache OpenNLP Tools 2.3.3 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="description" content="declaration: package: opennlp.tools.commons, annotation type: ThreadSafe">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.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">
 <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="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>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation-interface-optional-element-summary">Optional</a>&nbsp;|&nbsp;</li>
 <li>Required</li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation-interface-element-detail">Element</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </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="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">opennlp.tools.commons</a></div>
 <h1 title="Annotation Interface ThreadSafe" class="title">Annotation Interface ThreadSafe</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/17/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/17/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/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
 </span><span class="modifiers">public @interface </span><span class="element-name type-name-label">ThreadSafe</span></div>
 <div class="block">Classes, fields, or methods annotated <code>&amp;#64;ThreadSafe</code> are safe to use
  in multithreading contexts. In general, classes that adhere to (one of)
  the following concepts:
  <ul>
   <li>Statelessness: <b>no</b> methods relies on external state or
       maintain state at all,</li>
   <li>Immutability: <b>all</b> attributes are <code>final</code> so that
       internal state can't be modified at all,</li>
   <li>Thread locality: non-<code>final</code> fields are <b>only</b>
       accessed via an independently initialized copy,</li>
   <li>Atomicity: <b>all</b> operations on fields are perform via
       <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/package-summary.html" class="external-link"><code>atomic data types</code></a>, or</li>
   <li>Synchronization: <b>all</b> non-final methods, fields, or
       method local variables are manipulated via locks, that is, in a
       <code>synchronized</code> manner</li>
  </ul>
  are safe to use from multiple threads. In addition, thread-safety can be
  achieved by using the concepts of either
  <ul>
    <li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantLock.html" title="class or interface in java.util.concurrent.locks" class="external-link"><code>ReentrantLock</code></a>, or
    <li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link"><code>ReadWriteLock</code></a>
  </ul>
  in which a thread acquires the lock for write operations and protects
  the locked object or data element from changes until the lock is released.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== 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/17/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="#since()" class="member-name-link">since</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The OpenNLP release when an element was first declared <code>thread-safe</code>.</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="since()">
 <h3>since</h3>
 <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">since</span></div>
 <div class="block">The OpenNLP release when an element was first declared <code>thread-safe</code>.</div>
 <dl class="notes">
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="de">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>ThreadSafe (Apache OpenNLP Tools 2.3.3 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="description" content="declaration: package: opennlp.tools.commons, annotation type: ThreadSafe">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.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">
	<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="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>
	</div>
	<div class="sub-nav">
	<div>
	<ul class="sub-nav-list">
	<li>Summary: </li>
	<li>Field \| </li>
	<li><a href="#annotation-interface-optional-element-summary">Optional</a> \| </li>
	<li>Required</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"><label for="search-input">SEARCH:</label>
	<input type="text" id="search-input" value="search" disabled="disabled">
	<input type="reset" id="reset-button" value="reset" disabled="disabled">
	</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="package-label-in-type">Package</span> <a href="package-summary.html">opennlp.tools.commons</a></div>
	<h1 title="Annotation Interface ThreadSafe" class="title">Annotation Interface ThreadSafe</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/17/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/17/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/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
	</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">ThreadSafe</span></div>
	<div class="block">Classes, fields, or methods annotated <code>&#64;ThreadSafe</code> are safe to use
	in multithreading contexts. In general, classes that adhere to (one of)
	the following concepts:
	<ul>
	<li>Statelessness: <b>no</b> methods relies on external state or
	maintain state at all,</li>
	<li>Immutability: <b>all</b> attributes are <code>final</code> so that
	internal state can't be modified at all,</li>
	<li>Thread locality: non-<code>final</code> fields are <b>only</b>
	accessed via an independently initialized copy,</li>
	<li>Atomicity: <b>all</b> operations on fields are perform via
	<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/package-summary.html" class="external-link"><code>atomic data types</code></a>, or</li>
	<li>Synchronization: <b>all</b> non-final methods, fields, or
	method local variables are manipulated via locks, that is, in a
	<code>synchronized</code> manner</li>
	</ul>
	are safe to use from multiple threads. In addition, thread-safety can be
	achieved by using the concepts of either
	<ul>
	<li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReentrantLock.html" title="class or interface in java.util.concurrent.locks" class="external-link"><code>ReentrantLock</code></a>, or
	<li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/ReadWriteLock.html" title="class or interface in java.util.concurrent.locks" class="external-link"><code>ReadWriteLock</code></a>
	</ul>
	in which a thread acquires the lock for write operations and protects
	the locked object or data element from changes until the lock is released.</div>
	</section>
	<section class="summary">
	<ul class="summary-list">
	<!-- =========== 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/17/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="#since()" class="member-name-link">since</a></code></div>
	<div class="col-last even-row-color">
	<div class="block">The OpenNLP release when an element was first declared <code>thread-safe</code>.</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="since()">
	<h3>since</h3>
	<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/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">since</span></div>
	<div class="block">The OpenNLP release when an element was first declared <code>thread-safe</code>.</div>
	<dl class="notes">
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	<footer role="contentinfo">
	<hr>
	<p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>