blob: 6ecffc322135dd4376338abbd506a6cd05c584a7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>ObjectStream (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.util, interface: ObjectStream">
<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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.util</a></div>
<h1 title="Interface ObjectStream" class="title">Interface ObjectStream&lt;T&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../ml/model/SequenceStream.html" title="interface in opennlp.tools.ml.model">SequenceStream</a>&lt;S&gt;</code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractEventStream.html" title="class in opennlp.tools.util">AbstractEventStream</a></code>, <code><a href="AbstractObjectStream.html" title="class in opennlp.tools.util">AbstractObjectStream</a></code>, <code><a href="../parser/AbstractParserEventStream.html" title="class in opennlp.tools.parser">AbstractParserEventStream</a></code>, <code><a href="../formats/convert/AbstractToSentenceSampleStream.html" title="class in opennlp.tools.formats.convert">AbstractToSentenceSampleStream</a></code>, <code><a href="../formats/ad/ADChunkSampleStream.html" title="class in opennlp.tools.formats.ad">ADChunkSampleStream</a></code>, <code><a href="../formats/ad/ADNameSampleStream.html" title="class in opennlp.tools.formats.ad">ADNameSampleStream</a></code>, <code><a href="../formats/ad/ADPOSSampleStream.html" title="class in opennlp.tools.formats.ad">ADPOSSampleStream</a></code>, <code><a href="../formats/ad/ADSentenceSampleStream.html" title="class in opennlp.tools.formats.ad">ADSentenceSampleStream</a></code>, <code><a href="../formats/ad/ADSentenceStream.html" title="class in opennlp.tools.formats.ad">ADSentenceStream</a></code>, <code><a href="../formats/BioNLP2004NameSampleStream.html" title="class in opennlp.tools.formats">BioNLP2004NameSampleStream</a></code>, <code><a href="../formats/brat/BratAnnotationStream.html" title="class in opennlp.tools.formats.brat">BratAnnotationStream</a></code>, <code><a href="../formats/brat/BratDocumentStream.html" title="class in opennlp.tools.formats.brat">BratDocumentStream</a></code>, <code><a href="../formats/brat/BratNameSampleStream.html" title="class in opennlp.tools.formats.brat">BratNameSampleStream</a></code>, <code><a href="../chunker/ChunkerEventStream.html" title="class in opennlp.tools.chunker">ChunkerEventStream</a></code>, <code><a href="../chunker/ChunkSampleSequenceStream.html" title="class in opennlp.tools.chunker">ChunkSampleSequenceStream</a></code>, <code><a href="../chunker/ChunkSampleStream.html" title="class in opennlp.tools.chunker">ChunkSampleStream</a></code>, <code><a href="../parser/ChunkSampleStream.html" title="class in opennlp.tools.parser">ChunkSampleStream</a></code>, <code><a href="CollectionObjectStream.html" title="class in opennlp.tools.util">CollectionObjectStream</a></code>, <code><a href="../formats/Conll02NameSampleStream.html" title="class in opennlp.tools.formats">Conll02NameSampleStream</a></code>, <code><a href="../formats/Conll03NameSampleStream.html" title="class in opennlp.tools.formats">Conll03NameSampleStream</a></code>, <code><a href="../formats/conllu/ConlluLemmaSampleStream.html" title="class in opennlp.tools.formats.conllu">ConlluLemmaSampleStream</a></code>, <code><a href="../formats/conllu/ConlluPOSSampleStream.html" title="class in opennlp.tools.formats.conllu">ConlluPOSSampleStream</a></code>, <code><a href="../formats/conllu/ConlluSentenceSampleStream.html" title="class in opennlp.tools.formats.conllu">ConlluSentenceSampleStream</a></code>, <code><a href="../formats/conllu/ConlluStream.html" title="class in opennlp.tools.formats.conllu">ConlluStream</a></code>, <code><a href="../formats/conllu/ConlluTokenSampleStream.html" title="class in opennlp.tools.formats.conllu">ConlluTokenSampleStream</a></code>, <code><a href="../formats/ConllXPOSSampleStream.html" title="class in opennlp.tools.formats">ConllXPOSSampleStream</a></code>, <code><a href="../formats/frenchtreebank/ConstitParseSampleStream.html" title="class in opennlp.tools.formats.frenchtreebank">ConstitParseSampleStream</a></code>, <code><a href="eval/CrossValidationPartitioner.TrainingSampleStream.html" title="class in opennlp.tools.util.eval">CrossValidationPartitioner.TrainingSampleStream</a></code>, <code><a href="../formats/letsmt/DetokenizeSentenceSampleStream.html" title="class in opennlp.tools.formats.letsmt">DetokenizeSentenceSampleStream</a></code>, <code><a href="../formats/DirectorySampleStream.html" title="class in opennlp.tools.formats">DirectorySampleStream</a></code>, <code><a href="../doccat/DocumentCategorizerEventStream.html" title="class in opennlp.tools.doccat">DocumentCategorizerEventStream</a></code>, <code><a href="../doccat/DocumentSampleStream.html" title="class in opennlp.tools.doccat">DocumentSampleStream</a></code>, <code><a href="../formats/ontonotes/DocumentToLineStream.html" title="class in opennlp.tools.formats.ontonotes">DocumentToLineStream</a></code>, <code><a href="../sentdetect/EmptyLinePreprocessorStream.html" title="class in opennlp.tools.sentdetect">EmptyLinePreprocessorStream</a></code>, <code><a href="../formats/EvalitaNameSampleStream.html" title="class in opennlp.tools.formats">EvalitaNameSampleStream</a></code>, <code><a href="EventTraceStream.html" title="class in opennlp.tools.util">EventTraceStream</a></code>, <code><a href="../ml/model/FileEventStream.html" title="class in opennlp.tools.ml.model">FileEventStream</a></code>, <code><a href="../formats/convert/FileToByteArraySampleStream.html" title="class in opennlp.tools.formats.convert">FileToByteArraySampleStream</a></code>, <code><a href="../formats/convert/FileToStringSampleStream.html" title="class in opennlp.tools.formats.convert">FileToStringSampleStream</a></code>, <code><a href="FilterObjectStream.html" title="class in opennlp.tools.util">FilterObjectStream</a></code>, <code><a href="../ml/model/HashSumEventStream.html" title="class in opennlp.tools.ml.model">HashSumEventStream</a></code>, <code><a href="../langdetect/LanguageDetectorEventStream.html" title="class in opennlp.tools.langdetect">LanguageDetectorEventStream</a></code>, <code><a href="../langdetect/LanguageDetectorSampleStream.html" title="class in opennlp.tools.langdetect">LanguageDetectorSampleStream</a></code>, <code><a href="../formats/leipzig/LeipzigLanguageSampleStream.html" title="class in opennlp.tools.formats.leipzig">LeipzigLanguageSampleStream</a></code>, <code><a href="../lemmatizer/LemmaSampleEventStream.html" title="class in opennlp.tools.lemmatizer">LemmaSampleEventStream</a></code>, <code><a href="../lemmatizer/LemmaSampleSequenceStream.html" title="class in opennlp.tools.lemmatizer">LemmaSampleSequenceStream</a></code>, <code><a href="../lemmatizer/LemmaSampleStream.html" title="class in opennlp.tools.lemmatizer">LemmaSampleStream</a></code>, <code><a href="../formats/masc/MascDocumentStream.html" title="class in opennlp.tools.formats.masc">MascDocumentStream</a></code>, <code><a href="../formats/masc/MascNamedEntitySampleStream.html" title="class in opennlp.tools.formats.masc">MascNamedEntitySampleStream</a></code>, <code><a href="../formats/masc/MascPOSSampleStream.html" title="class in opennlp.tools.formats.masc">MascPOSSampleStream</a></code>, <code><a href="../formats/masc/MascSentenceSampleStream.html" title="class in opennlp.tools.formats.masc">MascSentenceSampleStream</a></code>, <code><a href="../formats/masc/MascTokenSampleStream.html" title="class in opennlp.tools.formats.masc">MascTokenSampleStream</a></code>, <code><a href="../formats/moses/MosesSentenceSampleStream.html" title="class in opennlp.tools.formats.moses">MosesSentenceSampleStream</a></code>, <code><a href="../formats/muc/MucNameSampleStream.html" title="class in opennlp.tools.formats.muc">MucNameSampleStream</a></code>, <code><a href="../formats/NameFinderCensus90NameStream.html" title="class in opennlp.tools.formats">NameFinderCensus90NameStream</a></code>, <code><a href="../namefind/NameFinderEventStream.html" title="class in opennlp.tools.namefind">NameFinderEventStream</a></code>, <code><a href="../cmdline/namefind/NameSampleCountersStream.html" title="class in opennlp.tools.cmdline.namefind">NameSampleCountersStream</a></code>, <code><a href="../namefind/NameSampleDataStream.html" title="class in opennlp.tools.namefind">NameSampleDataStream</a></code>, <code><a href="../namefind/NameSampleSequenceStream.html" title="class in opennlp.tools.namefind">NameSampleSequenceStream</a></code>, <code><a href="../namefind/NameSampleTypeFilter.html" title="class in opennlp.tools.namefind">NameSampleTypeFilter</a></code>, <code><a href="../formats/convert/NameToSentenceSampleStream.html" title="class in opennlp.tools.formats.convert">NameToSentenceSampleStream</a></code>, <code><a href="../formats/convert/NameToTokenSampleStream.html" title="class in opennlp.tools.formats.convert">NameToTokenSampleStream</a></code>, <code><a href="../formats/nkjp/NKJPSentenceSampleStream.html" title="class in opennlp.tools.formats.nkjp">NKJPSentenceSampleStream</a></code>, <code><a href="../formats/ontonotes/OntoNotesNameSampleStream.html" title="class in opennlp.tools.formats.ontonotes">OntoNotesNameSampleStream</a></code>, <code><a href="../formats/ontonotes/OntoNotesParseSampleStream.html" title="class in opennlp.tools.formats.ontonotes">OntoNotesParseSampleStream</a></code>, <code><a href="ParagraphStream.html" title="class in opennlp.tools.util">ParagraphStream</a></code>, <code><a href="../parser/chunking/ParserEventStream.html" title="class in opennlp.tools.parser.chunking">ParserEventStream</a></code>, <code><a href="../parser/treeinsert/ParserEventStream.html" title="class in opennlp.tools.parser.treeinsert">ParserEventStream</a></code>, <code><a href="../parser/ParseSampleStream.html" title="class in opennlp.tools.parser">ParseSampleStream</a></code>, <code><a href="../formats/convert/ParseToPOSSampleStream.html" title="class in opennlp.tools.formats.convert">ParseToPOSSampleStream</a></code>, <code><a href="PlainTextByLineStream.html" title="class in opennlp.tools.util">PlainTextByLineStream</a></code>, <code><a href="../postag/POSSampleEventStream.html" title="class in opennlp.tools.postag">POSSampleEventStream</a></code>, <code><a href="../postag/POSSampleSequenceStream.html" title="class in opennlp.tools.postag">POSSampleSequenceStream</a></code>, <code><a href="../parser/PosSampleStream.html" title="class in opennlp.tools.parser">PosSampleStream</a></code>, <code><a href="../formats/convert/POSToSentenceSampleStream.html" title="class in opennlp.tools.formats.convert">POSToSentenceSampleStream</a></code>, <code><a href="../formats/convert/POSToTokenSampleStream.html" title="class in opennlp.tools.formats.convert">POSToTokenSampleStream</a></code>, <code><a href="../ml/maxent/RealBasicEventStream.html" title="class in opennlp.tools.ml.maxent">RealBasicEventStream</a></code>, <code><a href="../ml/model/RealValueFileEventStream.html" title="class in opennlp.tools.ml.model">RealValueFileEventStream</a></code>, <code><a href="../sentdetect/SDEventStream.html" title="class in opennlp.tools.sentdetect">SDEventStream</a></code>, <code><a href="../formats/brat/SegmenterObjectStream.html" title="class in opennlp.tools.formats.brat">SegmenterObjectStream</a></code>, <code><a href="../sentdetect/SentenceSampleStream.html" title="class in opennlp.tools.sentdetect">SentenceSampleStream</a></code>, <code><a href="../ml/model/SequenceStreamEventStream.html" title="class in opennlp.tools.ml.model">SequenceStreamEventStream</a></code>, <code><a href="../tokenize/TokenizerStream.html" title="class in opennlp.tools.tokenize">TokenizerStream</a></code>, <code><a href="../tokenize/TokenSampleStream.html" title="class in opennlp.tools.tokenize">TokenSampleStream</a></code>, <code><a href="../tokenize/TokSpanEventStream.html" title="class in opennlp.tools.tokenize">TokSpanEventStream</a></code>, <code><a href="../formats/TwentyNewsgroupSampleStream.html" title="class in opennlp.tools.formats">TwentyNewsgroupSampleStream</a></code>, <code><a href="../tokenize/WhitespaceTokenStream.html" title="class in opennlp.tools.tokenize">WhitespaceTokenStream</a></code>, <code><a href="../postag/WordTagSampleStream.html" title="class in opennlp.tools.postag">WordTagSampleStream</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ObjectStream&lt;T&gt;</span><span class="extends-implements">
extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
<div class="block">Reads <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>objects</code></a> from a stream.
<p>
Design Decision:<br>
This interface provides a means for iterating over the
objects in a stream, it does not implement <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> or
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link"><code>Iterable</code></a> because:
<ul>
<li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#next()" title="class or interface in java.util" class="external-link"><code>Iterator.next()</code></a> and <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html#hasNext()" title="class or interface in java.util" class="external-link"><code>Iterator.hasNext()</code></a> are declared as
throwing no checked exceptions. Thus the <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"><code>IOException</code></a>s thrown by
<a href="#read()"><code>read()</code></a> would have to be wrapped in <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link"><code>RuntimeException</code></a>s,
and the compiler would be unable to force users of this code to catch
such exceptions.</li>
<li>Implementing <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link"><code>Iterable</code></a> would mean either silently calling
<a href="#reset()"><code>reset()</code></a> to guarantee that all items were always seen on each
iteration, or documenting that the Iterable only iterates over the remaining
elements of the ObjectStream. In either case, users not reading the
documentation carefully might run into unexpected behavior.</li>
</ul></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/ObjectStreamException.html" title="class or interface in java.io" class="external-link"><code>ObjectStreamException</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Closes the <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> and releases all allocated
resources.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ObjectStream.html" title="type parameter in ObjectStream">T</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#read()" class="member-name-link">read</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the next <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> object.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Repositions the stream at the beginning and the previously seen object sequence
will be repeated exactly.</div>
</div>
</div>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="read()">
<h3>read</h3>
<div class="member-signature"><span class="return-type"><a href="ObjectStream.html" title="type parameter in ObjectStream">T</a></span>&nbsp;<span class="element-name">read</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">Returns the next <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> object. Calling this method repeatedly until it returns
<code>null</code> will return each object from the underlying source exactly once.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The next object or <code>null</code> to signal that the stream is exhausted.</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> - Thrown if there is an error during reading.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="reset()">
<h3>reset</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">reset</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">Repositions the stream at the beginning and the previously seen object sequence
will be repeated exactly. This method can be used to re-read
the stream if multiple passes over the objects are required.
<p>
The implementation of this method is optional.</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> - Thrown if there is an error during resetting the stream.</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - Thrown if the <code>reset()</code> is not supported.
By default, this is the case.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</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">Closes the <a href="ObjectStream.html" title="interface in opennlp.tools.util"><code>ObjectStream</code></a> and releases all allocated
resources. After close was called, it's not allowed to call
<a href="#read()"><code>read()</code></a> or <a href="#reset()"><code>reset()</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</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> - Thrown if there is an error during closing the stream.</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>