org.apache.sis.metadata/org/apache/sis/xml/MarshalContext.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (24) on Mon Sep 29 10:48:08 CEST 2025 -->
 <title>MarshalContext (Apache SIS 1.5 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="2025-09-29">
 <meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.xml, class: MarshalContext">
 <meta name="generator" content="javadoc/ClassWriter">
 <meta name="keywords" content="org.apache.sis.xml.MarshalContext class">
 <meta name="keywords" content="getPool()">
 <meta name="keywords" content="getLocale()">
 <meta name="keywords" content="getZoneId()">
 <meta name="keywords" content="getTimeZone()">
 <meta name="keywords" content="getVersion()">
 <meta name="keywords" content="getDocumentURI()">
 <link rel="stylesheet" type="text/css" href="../../../../../resource-files/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../resource-files/sis.css" title="Style">
 <script type="text/javascript" src="../../../../../script-files/script.js"></script>
 <script type="text/javascript" src="../../../../../script-files/jquery-3.7.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-files/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">const pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="nav-content">
 <div class="nav-menu-button"><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>
 <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">Class</li>
 <li><a href="class-use/MarshalContext.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../new-list.html">New</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../search.html">Search</a></li>
 <li><a href="../../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 </div>
 <div class="sub-nav">
 <div class="nav-content">
 <ol class="sub-nav-list">
 <li><a href="../../../../module-summary.html">org.apache.sis.metadata</a></li>
 <li><a href="package-summary.html">org.apache.sis.xml</a></li>
 <li><a href="MarshalContext.html" class="current-selection">MarshalContext</a></li>
 </ol>
 <div class="nav-list-search">
 <input type="text" id="search-input" disabled placeholder="Search" aria-label="Search in documentation" autocomplete="off">
 <input type="reset" id="reset-search" disabled value="Reset">
 </div>
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="main-grid">
 <nav role="navigation" class="toc" aria-label="Table of contents">
 <div class="toc-header">Contents&nbsp;
 <input type="text" class="filter-input" disabled placeholder="Filter" aria-label="Filter table of contents" autocomplete="off">
 <input type="reset" class="reset-filter" disabled value="Reset">
 </div>
 <button class="hide-sidebar"><span>Hide sidebar&nbsp;</span>&#10094;</button><button class="show-sidebar">&#10095;<span>&nbsp;Show sidebar</span></button>
 <ol class="toc-list">
 <li><a href="#" tabindex="0">Description</a></li>
 <li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li>
 <li><a href="#method-summary" tabindex="0">Method Summary</a></li>
 <li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
 <ol class="toc-list">
 <li><a href="#%3Cinit%3E()" tabindex="0">MarshalContext()</a></li>
 </ol>
 </li>
 <li><a href="#method-detail" tabindex="0">Method Details</a>
 <ol class="toc-list">
 <li><a href="#getPool()" tabindex="0">getPool()</a></li>
 <li><a href="#getLocale()" tabindex="0">getLocale()</a></li>
 <li><a href="#getZoneId()" tabindex="0">getZoneId()</a></li>
 <li><a href="#getTimeZone()" tabindex="0">getTimeZone()</a></li>
 <li><a href="#getVersion(java.lang.String)" tabindex="0">getVersion(String)</a></li>
 <li><a href="#getDocumentURI()" tabindex="0">getDocumentURI()</a></li>
 </ol>
 </li>
 </ol>
 </nav>
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <h1 title="Class MarshalContext" class="title">Class MarshalContext</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance">MarshalContext</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
 </dl>
 <hr>
 <div class="horizontal-scroll">
 <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">MarshalContext</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 implements <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></span></div>
 <div class="block">Context of a marshalling or unmarshalling process.</div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.3</dd>
 </dl>
 </div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== 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 three-column-summary">
 <div class="table-header col-first">Modifier</div>
 <div class="table-header col-second">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>protected </code></div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">MarshalContext</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new (un)marshalling context.</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-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-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" aria-labelledby="method-summary-table-tab0">
 <div class="summary-table three-column-summary">
 <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>abstract <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDocumentURI()" class="member-name-link">getDocumentURI</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Returns the URI of the document being (un)marshalled, if this URI is known.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getLocale()" class="member-name-link">getLocale</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 locale to use for (un)marshalling, or <code>null</code> if no locale was explicitly specified.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="MarshallerPool.html" title="class in org.apache.sis.xml">MarshallerPool</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPool()" class="member-name-link">getPool</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Returns the marshaller pool that produced the marshaller or unmarshaller in use.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeZone()" class="member-name-link">getTimeZone</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the legacy timezone to use for (un)marshalling, or <code>null</code> if none was explicitly specified.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="../../../../../org.apache.sis.util/org/apache/sis/util/Version.html" title="class in org.apache.sis.util">Version</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVersion(java.lang.String)" class="member-name-link">getVersion</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;prefix)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Returns the schema version of the XML document being (un)marshalled.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/time/ZoneId.html" title="class or interface in java.time" class="external-link">ZoneId</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getZoneId()" class="member-name-link">getZoneId</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 timezone to use for (un)marshalling, or <code>null</code> if none was explicitly specified.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/25/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/25/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/25/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/25/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/25/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/25/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/25/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/25/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/25/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/25/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/25/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/25/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>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= 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>MarshalContext</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">MarshalContext</span>()</div>
 <div class="block">Creates a new (un)marshalling context.</div>
 </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="getPool()">
 <h3>getPool</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="MarshallerPool.html" title="class in org.apache.sis.xml">MarshallerPool</a></span>&nbsp;<span class="element-name">getPool</span>()</div>
 <div class="block">Returns the marshaller pool that produced the marshaller or unmarshaller in use.
  This pool may be used for creating new (un)marshaller when a document contains
  <code>xlink:href</code> to another document.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the marshaller pool that produced the marshaller or unmarshaller in use.</dd>
 <dt>Since:</dt>
 <dd>1.5</dd>
 </dl>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getLocale()">
 <h3>getLocale</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">getLocale</span>()</div>
 <div class="block">Returns the locale to use for (un)marshalling, or <code>null</code> if no locale was explicitly specified.
  The locale returned by this method can be used for choosing a language in an <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a>.

  <p>This locale may vary in different fragments of the same XML document.
  In particular children of <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html" title="class or interface in org.opengis.metadata" class="external-link"><code>Metadata</code></a> inherit the locale
  specified by the <a href="https://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/metadata/Metadata.html#getLanguage()" title="class or interface in org.opengis.metadata" class="external-link"><code>Metadata.getLanguage()</code></a> attribute.</p>

  <h4 id="handling-of-locale-root-heading">Handling of <code>Locale.ROOT</code></h4>
  <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Locale.html#ROOT" title="class or interface in java.util" class="external-link"><code>Locale.ROOT</code></a> is interpreted as a request for locale-neutral strings.
  The meaning of "locale-neutral" is implementation specific - this is usually
  very close to the English locale, but not necessarily. For examples dates are
  formatted according ISO standard instead of the rules of the English locale.

  <h4 id="handling-of-null-locale-heading">Handling of <code>null</code> locale</h4>
  A <code>null</code> value means that the locale is unspecified. Callers are encouraged
  to use the root locale as the default value, but some flexibility is allowed.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html#getLocale()">getLocale</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
 <dt>Returns:</dt>
 <dd>the locale for the XML fragment being (un)marshalled, or <code>null</code> if unspecified.</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
 <li><a href="../../../../../org.apache.sis.util/org/apache/sis/util/DefaultInternationalString.html#toString(java.util.Locale)"><code>DefaultInternationalString.toString(Locale)</code></a></li>
 </ul>
 </dd>
 </dl>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getZoneId()">
 <h3>getZoneId</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/time/ZoneId.html" title="class or interface in java.time" class="external-link">ZoneId</a></span>&nbsp;<span class="element-name">getZoneId</span>()</div>
 <div class="block">Returns the timezone to use for (un)marshalling, or <code>null</code> if none was explicitly specified.

  <h4 id="handling-of-null-timezone-heading">Handling of <code>null</code> timezone</h4>
  A <code>null</code> value means that the timezone is unspecified. Callers are encouraged
  to use the <abbr>UTC</abbr> timezone as the default value, but some flexibility is allowed.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the timezone for the <abbr>XML</abbr> fragment being (un)marshalled, or <code>null</code> if unspecified.</dd>
 <dt>Since:</dt>
 <dd>1.5</dd>
 </dl>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getTimeZone()">
 <h3>getTimeZone</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a></span>&nbsp;<span class="element-name">getTimeZone</span>()</div>
 <div class="block">Returns the legacy timezone to use for (un)marshalling, or <code>null</code> if none was explicitly specified.
  This is he value returned by <a href="#getZoneId()"><code>getZoneId()</code></a> converted to the legacy Java object.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the timezone for the XML fragment being (un)marshalled, or <code>null</code> if unspecified.</dd>
 </dl>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getVersion(java.lang.String)">
 <h3>getVersion</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Version.html" title="class in org.apache.sis.util">Version</a></span>&nbsp;<span class="element-name">getVersion</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;prefix)</span></div>
 <div class="block">Returns the schema version of the XML document being (un)marshalled.
  The <code>prefix</code> argument can be any of the following values (case-sensitive):

  <table class="sis">
    <caption>Supported schemas</caption>
    <tr><th>Prefix</th>  <th>Standard</th>                   <th>Typical values</th></tr>
    <tr><td>gml</td>     <td>Geographic Markup Language</td> <td><code>3.0</code>, <code>3.2</code></td></tr>
    <tr><td>gmd</td>     <td>Geographic MetaData</td>        <td><code>2007</code>, <code>2016</code></td></tr>
  </table></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>prefix</code> - one of the above-cited prefix.</dd>
 <dt>Returns:</dt>
 <dd>the version for the given schema, or <code>null</code> if unknown.</dd>
 </dl>
 </div>
 </section>
 </li>
 <li>
 <section class="detail" id="getDocumentURI()">
 <h3>getDocumentURI</h3>
 <div class="horizontal-scroll">
 <div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&gt;</span>&nbsp;<span class="element-name">getDocumentURI</span>()</div>
 <div class="block">Returns the URI of the document being (un)marshalled, if this URI is known.
  The URI is generally unknown if the source of the XML document is,
  for example, an <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link"><code>InputStream</code></a>.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the URI of the document being marshalled or unmarshalled.</dd>
 <dt>Since:</dt>
 <dd>1.5</dd>
 </dl>
 </div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </body>
 </html>