| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>opennlp.tools.util (Apache OpenNLP Tools 2.5.6 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.util"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package opennlp.tools.util" class="title">Package opennlp.tools.util</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">opennlp.tools.util</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Package containing utility data structures and algorithms used by multiple other packages.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="eval/package-summary.html">opennlp.tools.util.eval</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="ext/package-summary.html">opennlp.tools.util.ext</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Package containing extension loading code.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="featuregen/package-summary.html">opennlp.tools.util.featuregen</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This package contains classes for generating sequence features.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="java/package-summary.html">opennlp.tools.util.java</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="jvm/package-summary.html">opennlp.tools.util.jvm</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="model/package-summary.html">opennlp.tools.util.model</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="normalizer/package-summary.html">opennlp.tools.util.normalizer</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="wordvector/package-summary.html">opennlp.tools.util.wordvector</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab4" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab4', 2)" class="table-tab">Record Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0"> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractEventStream.html" title="class in opennlp.tools.util">AbstractEventStream</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A base <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> implementation for events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbstractObjectStream.html" title="class in opennlp.tools.util">AbstractObjectStream</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A base <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> implementation.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="BaseToolFactory.html" title="class in opennlp.tools.util">BaseToolFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for all tool <code>factories</code>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="BeamSearchContextGenerator.html" title="interface in opennlp.tools.util">BeamSearchContextGenerator</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface for context generators used with a sequence beam search.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Cache.html" title="class in opennlp.tools.util">Cache</a><K,<wbr>V></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Provides fixed size, pre-allocated, least recently used replacement cache.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CollectionObjectStream.html" title="class in opennlp.tools.util">CollectionObjectStream</a><E></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> implementation that works on a |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link"><code>Collection</code></a> of <a href="CollectionObjectStream.html" title="class in opennlp.tools.util"><code>CollectionObjectStream</code></a> as source for elements.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="DownloadUtil.html" title="class in opennlp.tools.util">DownloadUtil</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">This class facilitates the downloading of pretrained OpenNLP models.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EventTraceStream.html" title="class in opennlp.tools.util">EventTraceStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="FilterObjectStream.html" title="class in opennlp.tools.util">FilterObjectStream</a><S,<wbr>T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Abstract base class for filtering <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>streams</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="InputStreamFactory.html" title="interface in opennlp.tools.util">InputStreamFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Allows repeated reads through a stream for certain model building types.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab5"><a href="InsufficientTrainingDataException.html" title="class in opennlp.tools.util">InsufficientTrainingDataException</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab5"> |
| <div class="block">This exception indicates that the provided training data is |
| insufficient to train a desired model.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="InvalidFormatException.html" title="class in opennlp.tools.util">InvalidFormatException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">This exception indicates that a resource violates the expected data format.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="MarkableFileInputStreamFactory.html" title="class in opennlp.tools.util">MarkableFileInputStreamFactory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A factory that creates <code>MarkableFileInputStream</code> from a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link"><code>File</code></a></div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MutableInt.html" title="class in opennlp.tools.util">MutableInt</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">This is a non-thread safe mutable int.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ObjectStream.html" title="interface in opennlp.tools.util">ObjectStream</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Reads <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>objects</code></a> from a stream.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ObjectStreamUtils.html" title="class in opennlp.tools.util">ObjectStreamUtils</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="ParagraphStream.html" title="class in opennlp.tools.util">ParagraphStream</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="FilterObjectStream.html" title="class in opennlp.tools.util"><code>FilterObjectStream</code></a> which merges text lines into paragraphs.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PlainTextByLineStream.html" title="class in opennlp.tools.util">PlainTextByLineStream</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Reads a plain text file and returns each line as a <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"><code>String</code></a> object.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="ResetableIterator.html" title="interface in opennlp.tools.util">ResetableIterator</a><E></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">This interface makes an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link"><code>Iterator</code></a> resettable.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReverseListIterator.html" title="class in opennlp.tools.util">ReverseListIterator</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An iterator for a list which returns values in the opposite order as the typical list iterator.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Sequence.html" title="class in opennlp.tools.util">Sequence</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Represents a weighted sequence of outcomes.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SequenceCodec.html" title="interface in opennlp.tools.util">SequenceCodec</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A codec for sequences of type <a href="SequenceCodec.html" title="interface in opennlp.tools.util"><code>SequenceCodec</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="SequenceValidator.html" title="interface in opennlp.tools.util">SequenceValidator</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Span.html" title="class in opennlp.tools.util">Span</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Class for storing start and end integer offsets.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StringList.html" title="class in opennlp.tools.util">StringList</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A <a href="StringList.html" title="class in opennlp.tools.util"><code>StringList</code></a> is an immutable list of <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"><code>String</code></a>s.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StringUtil.html" title="class in opennlp.tools.util">StringUtil</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab4"><a href="TokenTag.html" title="class in opennlp.tools.util">TokenTag</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab4"> </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab4"><a href="TrainingConfiguration.html" title="class in opennlp.tools.util">TrainingConfiguration</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab4"> |
| <div class="block">Configuration used for <a href="../ml/model/AbstractModel.html" title="class in opennlp.tools.ml.model"><code>AbstractModel</code></a> training.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TrainingParameters.html" title="class in opennlp.tools.util">TrainingParameters</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Declares and handles default parameters used for or during training models.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Version.html" title="class in opennlp.tools.util">Version</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The <a href="Version.html" title="class in opennlp.tools.util"><code>Version</code></a> class represents the OpenNLP Tools library version.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="XmlUtil.html" title="class in opennlp.tools.util">XmlUtil</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
