1 // SAX default implementation for Locator.
2 // http://www.saxproject.org
3 // No warranty; no copyright -- use this as you will.
4 // $Id: LocatorImpl.java,v 1.6 2002/01/30 20:52:27 dbrownell Exp $
6 package org.xml.sax.helpers;
8 import org.xml.sax.Locator;
12 * Provide an optional convenience implementation of Locator.
15 * <em>This module, both source code and documentation, is in the
16 * Public Domain, and comes with <strong>NO WARRANTY</strong>.</em>
17 * See <a href='http://www.saxproject.org'>http://www.saxproject.org</a>
18 * for further information.
21 * <p>This class is available mainly for application writers, who
22 * can use it to make a persistent snapshot of a locator at any
23 * point during a document parse:</p>
29 * public void setLocator (Locator locator)
32 * this.locator = locator;
35 * public void startDocument ()
37 * // save the location of the start of the document
39 * Locator startloc = new LocatorImpl(locator);
43 * <p>Normally, parser writers will not use this class, since it
44 * is more efficient to provide location information only when
45 * requested, rather than constantly updating a Locator object.</p>
48 * @author David Megginson
49 * @version 2.0.1 (sax2r2)
50 * @see org.xml.sax.Locator Locator
52 public class LocatorImpl implements Locator
57 * Zero-argument constructor.
59 * <p>This will not normally be useful, since the main purpose
60 * of this class is to make a snapshot of an existing Locator.</p>
70 * <p>Create a persistent copy of the current state of a locator.
71 * When the original locator changes, this copy will still keep
72 * the original values (and it can be used outside the scope of
73 * DocumentHandler methods).</p>
75 * @param locator The locator to copy.
77 public LocatorImpl (Locator locator)
79 setPublicId(locator.getPublicId());
80 setSystemId(locator.getSystemId());
81 setLineNumber(locator.getLineNumber());
82 setColumnNumber(locator.getColumnNumber());
87 ////////////////////////////////////////////////////////////////////
88 // Implementation of org.xml.sax.Locator
89 ////////////////////////////////////////////////////////////////////
93 * Return the saved public identifier.
95 * @return The public identifier as a string, or null if none
97 * @see org.xml.sax.Locator#getPublicId
101 public String getPublicId ()
108 * Return the saved system identifier.
110 * @return The system identifier as a string, or null if none
112 * @see org.xml.sax.Locator#getSystemId
116 public String getSystemId ()
123 * Return the saved line number (1-based).
125 * @return The line number as an integer, or -1 if none is available.
126 * @see org.xml.sax.Locator#getLineNumber
127 * @see #setLineNumber
130 public int getLineNumber ()
137 * Return the saved column number (1-based).
139 * @return The column number as an integer, or -1 if none is available.
140 * @see org.xml.sax.Locator#getColumnNumber
141 * @see #setColumnNumber
144 public int getColumnNumber ()
151 ////////////////////////////////////////////////////////////////////
152 // Setters for the properties (not in org.xml.sax.Locator)
153 ////////////////////////////////////////////////////////////////////
157 * Set the public identifier for this locator.
159 * @param publicId The new public identifier, or null
160 * if none is available.
163 public void setPublicId (String publicId)
165 this.publicId = publicId;
170 * Set the system identifier for this locator.
172 * @param systemId The new system identifier, or null
173 * if none is available.
176 public void setSystemId (String systemId)
178 this.systemId = systemId;
183 * Set the line number for this locator (1-based).
185 * @param lineNumber The line number, or -1 if none is available.
186 * @see #getLineNumber
188 public void setLineNumber (int lineNumber)
190 this.lineNumber = lineNumber;
195 * Set the column number for this locator (1-based).
197 * @param columnNumber The column number, or -1 if none is available.
198 * @see #getColumnNumber
200 public void setColumnNumber (int columnNumber)
202 this.columnNumber = columnNumber;
207 ////////////////////////////////////////////////////////////////////
209 ////////////////////////////////////////////////////////////////////
211 private String publicId;
212 private String systemId;
213 private int lineNumber;
214 private int columnNumber;
218 // end of LocatorImpl.java