blob: 09a757c2723adac20cc38deead83b6426cdd9a58 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_391) on Sun Jun 22 17:31:33 IST 2025 -->
<title>SerializableLocatorImpl</title>
<meta name="date" content="2025-06-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SerializableLocatorImpl";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/xml/utils/SAXSourceLocator.html" title="class in org.apache.xml.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/xml/utils/StopParseException.html" title="class in org.apache.xml.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/xml/utils/SerializableLocatorImpl.html" target="_top">Frames</a></li>
<li><a href="SerializableLocatorImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.xml.utils</div>
<h2 title="Class SerializableLocatorImpl" class="title">Class SerializableLocatorImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.xml.utils.SerializableLocatorImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, org.xml.sax.Locator</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SerializableLocatorImpl</span>
extends java.lang.Object
implements org.xml.sax.Locator, java.io.Serializable</pre>
<div class="block">The standard SAX implementation of LocatorImpl is not serializable,
limiting its utility as "a persistent snapshot of a locator".
This is a quick hack to make it so. Note that it makes more sense
in many cases to set up fields to hold this data rather than pointing
at another object... but that decision should be made on architectural
grounds rather than serializability.
<p>
It isn't clear whether subclassing LocatorImpl and adding serialization
methods makes more sense than copying it and just adding Serializable
to its interface. Since it's so simple, I've taken the latter approach
for now.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>XalanJ2</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>LocatorImpl</code>,
<code>Locator</code>,
<a href="../../../../serialized-form.html#org.apache.xml.utils.SerializableLocatorImpl">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#SerializableLocatorImpl--">SerializableLocatorImpl</a></span>()</code>
<div class="block">Zero-argument constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#SerializableLocatorImpl-org.xml.sax.Locator-">SerializableLocatorImpl</a></span>(org.xml.sax.Locator&nbsp;locator)</code>
<div class="block">Copy constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getColumnNumber--">getColumnNumber</a></span>()</code>
<div class="block">Return the saved column number (1-based).</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getLineNumber--">getLineNumber</a></span>()</code>
<div class="block">Return the saved line number (1-based).</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getPublicId--">getPublicId</a></span>()</code>
<div class="block">Return the saved public identifier.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getSystemId--">getSystemId</a></span>()</code>
<div class="block">Return the saved system identifier.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setColumnNumber-int-">setColumnNumber</a></span>(int&nbsp;columnNumber)</code>
<div class="block">Set the column number for this locator (1-based).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setLineNumber-int-">setLineNumber</a></span>(int&nbsp;lineNumber)</code>
<div class="block">Set the line number for this locator (1-based).</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setPublicId-java.lang.String-">setPublicId</a></span>(java.lang.String&nbsp;publicId)</code>
<div class="block">Set the public identifier for this locator.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setSystemId-java.lang.String-">setSystemId</a></span>(java.lang.String&nbsp;systemId)</code>
<div class="block">Set the system identifier for this locator.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SerializableLocatorImpl--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SerializableLocatorImpl</h4>
<pre>public&nbsp;SerializableLocatorImpl()</pre>
<div class="block">Zero-argument constructor.
<p>SAX says "This will not normally be useful, since the main purpose
of this class is to make a snapshot of an existing Locator." In fact,
it _is_ sometimes useful when you want to construct a new Locator
pointing to a specific location... which, after all, is why the
setter methods are provided.
</p></div>
</li>
</ul>
<a name="SerializableLocatorImpl-org.xml.sax.Locator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SerializableLocatorImpl</h4>
<pre>public&nbsp;SerializableLocatorImpl(org.xml.sax.Locator&nbsp;locator)</pre>
<div class="block">Copy constructor.
<p>Create a persistent copy of the current state of a locator.
When the original locator changes, this copy will still keep
the original values (and it can be used outside the scope of
DocumentHandler methods).</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locator</code> - The locator to copy.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getPublicId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPublicId</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPublicId()</pre>
<div class="block">Return the saved public identifier.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getPublicId</code>&nbsp;in interface&nbsp;<code>org.xml.sax.Locator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The public identifier as a string, or null if none
is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Locator.getPublicId()</code>,
<a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setPublicId-java.lang.String-"><code>setPublicId(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getSystemId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemId</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSystemId()</pre>
<div class="block">Return the saved system identifier.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSystemId</code>&nbsp;in interface&nbsp;<code>org.xml.sax.Locator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The system identifier as a string, or null if none
is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Locator.getSystemId()</code>,
<a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setSystemId-java.lang.String-"><code>setSystemId(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getLineNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumber</h4>
<pre>public&nbsp;int&nbsp;getLineNumber()</pre>
<div class="block">Return the saved line number (1-based).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getLineNumber</code>&nbsp;in interface&nbsp;<code>org.xml.sax.Locator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The line number as an integer, or -1 if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Locator.getLineNumber()</code>,
<a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setLineNumber-int-"><code>setLineNumber(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="getColumnNumber--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNumber</h4>
<pre>public&nbsp;int&nbsp;getColumnNumber()</pre>
<div class="block">Return the saved column number (1-based).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getColumnNumber</code>&nbsp;in interface&nbsp;<code>org.xml.sax.Locator</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The column number as an integer, or -1 if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Locator.getColumnNumber()</code>,
<a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#setColumnNumber-int-"><code>setColumnNumber(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setPublicId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPublicId</h4>
<pre>public&nbsp;void&nbsp;setPublicId(java.lang.String&nbsp;publicId)</pre>
<div class="block">Set the public identifier for this locator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publicId</code> - The new public identifier, or null
if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getPublicId--"><code>getPublicId()</code></a></dd>
</dl>
</li>
</ul>
<a name="setSystemId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSystemId</h4>
<pre>public&nbsp;void&nbsp;setSystemId(java.lang.String&nbsp;systemId)</pre>
<div class="block">Set the system identifier for this locator.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>systemId</code> - The new system identifier, or null
if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getSystemId--"><code>getSystemId()</code></a></dd>
</dl>
</li>
</ul>
<a name="setLineNumber-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLineNumber</h4>
<pre>public&nbsp;void&nbsp;setLineNumber(int&nbsp;lineNumber)</pre>
<div class="block">Set the line number for this locator (1-based).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lineNumber</code> - The line number, or -1 if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getLineNumber--"><code>getLineNumber()</code></a></dd>
</dl>
</li>
</ul>
<a name="setColumnNumber-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setColumnNumber</h4>
<pre>public&nbsp;void&nbsp;setColumnNumber(int&nbsp;columnNumber)</pre>
<div class="block">Set the column number for this locator (1-based).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnNumber</code> - The column number, or -1 if none is available.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/xml/utils/SerializableLocatorImpl.html#getColumnNumber--"><code>getColumnNumber()</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/xml/utils/SAXSourceLocator.html" title="class in org.apache.xml.utils"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/xml/utils/StopParseException.html" title="class in org.apache.xml.utils"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/xml/utils/SerializableLocatorImpl.html" target="_top">Frames</a></li>
<li><a href="SerializableLocatorImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>