org.apache.sis.storage/org/apache/sis/storage/event/StoreListener.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
 <title>StoreListener (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.storage, package: org.apache.sis.storage.event, interface: StoreListener">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.storage.event.StoreListener interface">
 <meta name="keywords" content="eventOccured()">
 <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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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>Nested</li>
 <li>Field</li>
 <li>Constr</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li>Constr</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <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"><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>&nbsp;<a href="../../../../../module-summary.html">org.apache.sis.storage</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.storage.event</a></div>
 <h1 title="Interface StoreListener" class="title">Interface StoreListener&lt;E extends <a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>&gt;</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>E</code> - the type of events of interest to this listener.</dd>
 </dl>
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StoreListener&lt;E extends <a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>&gt;</span><span class="extends-implements">
 extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></span></div>
 <div class="block">An object which listens for events (typically changes or warnings) occurring in a resource
  or one of its children. The kind of event is defined by the subclass of the <a href="StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a>
  instance given to the <a href="#eventOccured(E)"><code>eventOccured(StoreEvent)</code></a> method. For example if a warning occurred
  while reading data from a file, then the event will be an instance of <a href="WarningEvent.html" title="class in org.apache.sis.storage.event"><code>WarningEvent</code></a>.

  <p><a href="../Resource.html" title="interface in org.apache.sis.storage"><code>Resource</code></a> implementations are responsible for instantiating the most specific
  <code>StoreEvent</code> subclass for the type of events. Then, all <code>StoreListener</code>s that
  <a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">declared an interest</a> for
  <code>StoreEvent</code>s of that kind are notified, including listeners in parent resources.
  Each listener is notified only once per event even if the listener is registered twice.</p></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>1.0</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a></li>
 <li><a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)"><code>Resource.addListener(Class, StoreListener)</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></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-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#eventOccured(E)" class="member-name-link">eventOccured</a><wbr>(<a href="StoreListener.html" title="type parameter in StoreListener">E</a>&nbsp;event)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Invoked <em>after</em> a warning or a change occurred in a resource.</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="eventOccured(E)">
 <h3 id="eventOccured(org.apache.sis.storage.event.StoreEvent)">eventOccured</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">eventOccured</span><wbr><span class="parameters">(<a href="StoreListener.html" title="type parameter in StoreListener">E</a>&nbsp;event)</span></div>
 <div class="block">Invoked <em>after</em> a warning or a change occurred in a resource.
  The <a href="StoreEvent.html#getSource()"><code>StoreEvent.getSource()</code></a> method gives the resource where the event occurred.
  It is not necessarily the <a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">resource in which this
  listener has been registered</a>; it may be one of the resource children.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>event</code> - description of the change or warning that occurred in a resource. Shall not be <code>null</code>.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
	<title>StoreListener (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.storage, package: org.apache.sis.storage.event, interface: StoreListener">
	<meta name="generator" content="javadoc/ClassWriterImpl">
	<meta name="keywords" content="org.apache.sis.storage.event.StoreListener interface">
	<meta name="keywords" content="eventOccured()">
	<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>Nested</li>
	<li>Field</li>
	<li>Constr</li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	</li>
	<li>
	<p>Detail:</p>
	<ul>
	<li>Field</li>
	<li>Constr</li>
	<li><a href="#method-detail">Method</a></li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="sub-nav">
	<div id="navbar-sub-list">
	<ul class="sub-nav-list">
	<li>Summary: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method-summary">Method</a></li>
	</ul>
	<ul class="sub-nav-list">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method-detail">Method</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.storage</a></div>
	<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.storage.event</a></div>
	<h1 title="Interface StoreListener" class="title">Interface StoreListener<E extends <a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>></h1>
	</div>
	<section class="class-description" id="class-description">
	<dl class="notes">
	<dt>Type Parameters:</dt>
	<dd><code>E</code> - the type of events of interest to this listener.</dd>
	</dl>
	<dl class="notes">
	<dt>All Superinterfaces:</dt>
	<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code></dd>
	</dl>
	<hr>
	<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StoreListener<E extends <a href="StoreEvent.html" title="class in org.apache.sis.storage.event">StoreEvent</a>></span><span class="extends-implements">
	extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></span></div>
	<div class="block">An object which listens for events (typically changes or warnings) occurring in a resource
	or one of its children. The kind of event is defined by the subclass of the <a href="StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a>
	instance given to the <a href="#eventOccured(E)"><code>eventOccured(StoreEvent)</code></a> method. For example if a warning occurred
	while reading data from a file, then the event will be an instance of <a href="WarningEvent.html" title="class in org.apache.sis.storage.event"><code>WarningEvent</code></a>.

	<p><a href="../Resource.html" title="interface in org.apache.sis.storage"><code>Resource</code></a> implementations are responsible for instantiating the most specific
	<code>StoreEvent</code> subclass for the type of events. Then, all <code>StoreListener</code>s that
	<a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">declared an interest</a> for
	<code>StoreEvent</code>s of that kind are notified, including listeners in parent resources.
	Each listener is notified only once per event even if the listener is registered twice.</p></div>
	<dl class="notes">
	<dt>Since:</dt>
	<dd>1.0</dd>
	<dt>See Also:</dt>
	<dd>
	<ul class="tag-list-long">
	<li><a href="StoreEvent.html" title="class in org.apache.sis.storage.event"><code>StoreEvent</code></a></li>
	<li><a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)"><code>Resource.addListener(Class, StoreListener)</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></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-tab3"><code>void</code></div>
	<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#eventOccured(E)" class="member-name-link">eventOccured</a><wbr>(<a href="StoreListener.html" title="type parameter in StoreListener">E</a> event)</code></div>
	<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
	<div class="block">Invoked <em>after</em> a warning or a change occurred in a resource.</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="eventOccured(E)">
	<h3 id="eventOccured(org.apache.sis.storage.event.StoreEvent)">eventOccured</h3>
	<div class="member-signature"><span class="return-type">void</span> <span class="element-name">eventOccured</span><wbr><span class="parameters">(<a href="StoreListener.html" title="type parameter in StoreListener">E</a> event)</span></div>
	<div class="block">Invoked <em>after</em> a warning or a change occurred in a resource.
	The <a href="StoreEvent.html#getSource()"><code>StoreEvent.getSource()</code></a> method gives the resource where the event occurred.
	It is not necessarily the <a href="../Resource.html#addListener(java.lang.Class,org.apache.sis.storage.event.StoreListener)">resource in which this
	listener has been registered</a>; it may be one of the resource children.</div>
	<dl class="notes">
	<dt>Parameters:</dt>
	<dd><code>event</code> - description of the change or warning that occurred in a resource. Shall not be <code>null</code>.</dd>
	</dl>
	</section>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</section>
	<!-- ========= END OF CLASS DATA ========= -->
	</main>
	</div>
	</div>
	</body>
	</html>