blob: 6b1f325ce6cd5946c8492d66ca1e321d581a7358 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>SimplePerceptronSequenceTrainer (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.ml.perceptron, class: SimplePerceptronSequenceTrainer">
<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 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><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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</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.ml.perceptron</a></div>
<h1 title="Class SimplePerceptronSequenceTrainer" class="title">Class SimplePerceptronSequenceTrainer</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="../AbstractTrainer.html" title="class in opennlp.tools.ml">opennlp.tools.ml.AbstractTrainer</a>
<div class="inheritance"><a href="../AbstractEventModelSequenceTrainer.html" title="class in opennlp.tools.ml">opennlp.tools.ml.AbstractEventModelSequenceTrainer</a>
<div class="inheritance">opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../commons/Trainer.html" title="interface in opennlp.tools.commons">Trainer</a></code>, <code><a href="../EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml">EventModelSequenceTrainer</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SimplePerceptronSequenceTrainer</span>
<span class="extends-implements">extends <a href="../AbstractEventModelSequenceTrainer.html" title="class in opennlp.tools.ml">AbstractEventModelSequenceTrainer</a></span></div>
<div class="block">Trains <a href="PerceptronModel.html" title="class in opennlp.tools.ml.perceptron"><code>models</code></a> with sequences using the perceptron algorithm.
<p>
Each outcome is represented as a binary perceptron classifier.
This supports standard (integer) weighting as well average weighting.
<p>
Sequence information is used in a simplified was to that described in:
Discriminative Training Methods for Hidden Markov Models: Theory and Experiments
with the Perceptron Algorithm. Michael Collins, EMNLP 2002.
<p>
Specifically only updates are applied to tokens which were incorrectly tagged by a sequence tagger
rather than to all feature across the sequence which differ from the training sequence.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="PerceptronModel.html" title="class in opennlp.tools.ml.perceptron"><code>PerceptronModel</code></a></li>
<li><a href="../AbstractEventModelSequenceTrainer.html" title="class in opennlp.tools.ml"><code>AbstractEventModelSequenceTrainer</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <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="#PERCEPTRON_SEQUENCE_VALUE" class="member-name-link">PERCEPTRON_SEQUENCE_VALUE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-opennlp.tools.ml.AbstractTrainer">Fields inherited from class&nbsp;opennlp.tools.ml.<a href="../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></h3>
<code><a href="../AbstractTrainer.html#ALGORITHM_PARAM">ALGORITHM_PARAM</a>, <a href="../AbstractTrainer.html#CUTOFF_DEFAULT">CUTOFF_DEFAULT</a>, <a href="../AbstractTrainer.html#CUTOFF_PARAM">CUTOFF_PARAM</a>, <a href="../AbstractTrainer.html#ITERATIONS_DEFAULT">ITERATIONS_DEFAULT</a>, <a href="../AbstractTrainer.html#ITERATIONS_PARAM">ITERATIONS_PARAM</a>, <a href="../AbstractTrainer.html#TRAINER_TYPE_PARAM">TRAINER_TYPE_PARAM</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-opennlp.tools.ml.EventModelSequenceTrainer">Fields inherited from interface&nbsp;opennlp.tools.ml.<a href="../EventModelSequenceTrainer.html" title="interface in opennlp.tools.ml">EventModelSequenceTrainer</a></h3>
<code><a href="../EventModelSequenceTrainer.html#SEQUENCE_VALUE">SEQUENCE_VALUE</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SimplePerceptronSequenceTrainer</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Instantiates a <a href="SimplePerceptronSequenceTrainer.html" title="class in opennlp.tools.ml.perceptron"><code>SimplePerceptronSequenceTrainer</code></a> with a default
configuration of training parameters.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doTrain(opennlp.tools.ml.model.SequenceStream)" class="member-name-link">doTrain</a><wbr>(<a href="../model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;&nbsp;events)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextIteration(int)" class="member-name-link">nextIteration</a><wbr>(int&nbsp;iteration)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#trainModel(int,opennlp.tools.ml.model.SequenceStream,int,boolean)" class="member-name-link">trainModel</a><wbr>(int&nbsp;iterations,
<a href="../model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;&nbsp;sequenceStream,
int&nbsp;cutoff,
boolean&nbsp;useAverage)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Trains a <a href="PerceptronModel.html" title="class in opennlp.tools.ml.perceptron"><code>PerceptronModel</code></a> with given parameters.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate()" class="member-name-link">validate</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks the configured <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>parameters</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.ml.AbstractEventModelSequenceTrainer">Methods inherited from class&nbsp;opennlp.tools.ml.<a href="../AbstractEventModelSequenceTrainer.html" title="class in opennlp.tools.ml">AbstractEventModelSequenceTrainer</a></h3>
<code><a href="../AbstractEventModelSequenceTrainer.html#train(opennlp.tools.ml.model.SequenceStream)">train</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.ml.AbstractTrainer">Methods inherited from class&nbsp;opennlp.tools.ml.<a href="../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></h3>
<code><a href="../AbstractTrainer.html#getAlgorithm()">getAlgorithm</a>, <a href="../AbstractTrainer.html#getCutoff()">getCutoff</a>, <a href="../AbstractTrainer.html#getIterations()">getIterations</a>, <a href="../AbstractTrainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map)">init</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-opennlp.tools.commons.Trainer">Methods inherited from interface&nbsp;opennlp.tools.commons.<a href="../../commons/Trainer.html" title="interface in opennlp.tools.commons">Trainer</a></h3>
<code><a href="../../commons/Trainer.html#init(opennlp.tools.util.TrainingParameters,java.util.Map)">init</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="PERCEPTRON_SEQUENCE_VALUE">
<h3>PERCEPTRON_SEQUENCE_VALUE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<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">PERCEPTRON_SEQUENCE_VALUE</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#opennlp.tools.ml.perceptron.SimplePerceptronSequenceTrainer.PERCEPTRON_SEQUENCE_VALUE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SimplePerceptronSequenceTrainer</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SimplePerceptronSequenceTrainer</span>()</div>
<div class="block">Instantiates a <a href="SimplePerceptronSequenceTrainer.html" title="class in opennlp.tools.ml.perceptron"><code>SimplePerceptronSequenceTrainer</code></a> with a default
configuration of training parameters.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="validate()">
<h3>validate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">validate</span>()</div>
<div class="block">Checks the configured <a href="../../util/TrainingParameters.html" title="class in opennlp.tools.util"><code>parameters</code></a>.
If a subclass overrides this, it should call <code>super.validate();</code>.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="../AbstractTrainer.html#validate()">validate</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractTrainer.html" title="class in opennlp.tools.ml">AbstractTrainer</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - Thrown if the algorithm name is not equal to
{<a href="#PERCEPTRON_SEQUENCE_VALUE"><code>PERCEPTRON_SEQUENCE_VALUE</code></a>}.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="doTrain(opennlp.tools.ml.model.SequenceStream)">
<h3>doTrain</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></span>&nbsp;<span class="element-name">doTrain</span><wbr><span class="parameters">(<a href="../model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;&nbsp;events)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../AbstractEventModelSequenceTrainer.html#doTrain(opennlp.tools.ml.model.SequenceStream)">doTrain</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractEventModelSequenceTrainer.html" title="class in opennlp.tools.ml">AbstractEventModelSequenceTrainer</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="trainModel(int,opennlp.tools.ml.model.SequenceStream,int,boolean)">
<h3>trainModel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../model/AbstractModel.html" title="class in opennlp.tools.ml.model">AbstractModel</a></span>&nbsp;<span class="element-name">trainModel</span><wbr><span class="parameters">(int&nbsp;iterations,
<a href="../model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;&nbsp;sequenceStream,
int&nbsp;cutoff,
boolean&nbsp;useAverage)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Trains a <a href="PerceptronModel.html" title="class in opennlp.tools.ml.perceptron"><code>PerceptronModel</code></a> with given parameters.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>iterations</code> - The number of iterations to use for training.</dd>
<dd><code>sequenceStream</code> - The <code><a href="../model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;<a href="../model/Event.html" title="class in opennlp.tools.ml.model">Event</a>&gt;</code> used as data input.</dd>
<dd><code>cutoff</code> - The {<a href="../AbstractTrainer.html#CUTOFF_PARAM"><code>AbstractTrainer.CUTOFF_PARAM</code></a>} value to use for training.</dd>
<dd><code>useAverage</code> - Whether to use 'averaging', or not.</dd>
<dt>Returns:</dt>
<dd>A valid, trained <a href="../model/AbstractModel.html" title="class in opennlp.tools.ml.model"><code>perceptron model</code></a>.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nextIteration(int)">
<h3>nextIteration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">nextIteration</span><wbr><span class="parameters">(int&nbsp;iteration)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></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>