LocatorImpl

AI-generated Key Takeaways

• LocatorImpl provides a convenient implementation of the Locator interface for SAX parsing.

• It allows developers to capture and store the current location during document parsing, like line and column numbers.

• This class is primarily useful for application writers who need to preserve location information.

• Parser writers generally avoid using LocatorImpl for efficiency reasons, as it involves constantly updating location data.

• LocatorImpl offers methods to get and set the column number, line number, public identifier, and system identifier.

public class LocatorImpl extends Object
implements Locator

Known Direct Subclasses Locator2Impl Locator2Impl SAX2 extension helper for holding additional Entity information, implementing the Locator2 interface.

Provide an optional convenience implementation of Locator.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class is available mainly for application writers, who can use it to make a persistent snapshot of a locator at any point during a document parse:

 Locator locator;
 Locator startloc;

 public void setLocator (Locator locator)
 {
         // note the locator
   this.locator = locator;
 }

 public void startDocument ()
 {
         // save the location of the start of the document
         // for future use.
   Locator startloc = new LocatorImpl(locator);
 }

Normally, parser writers will not use this class, since it is more efficient to provide location information only when requested, rather than constantly updating a Locator object.

See Also

• Locator

Public Constructor Summary

	LocatorImpl() Zero-argument constructor.
	LocatorImpl(Locator locator) Copy constructor.

Public Method Summary

int	getColumnNumber() Return the saved column number (1-based).
int	getLineNumber() Return the saved line number (1-based).
String	getPublicId() Return the saved public identifier.
String	getSystemId() Return the saved system identifier.
void	setColumnNumber(int columnNumber) Set the column number for this locator (1-based).
void	setLineNumber(int lineNumber) Set the line number for this locator (1-based).
void	setPublicId(String publicId) Set the public identifier for this locator.
void	setSystemId(String systemId) Set the system identifier for this locator.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface org.xml.sax.Locator

abstract int	getColumnNumber() Return the column number where the current document event ends.
abstract int	getLineNumber() Return the line number where the current document event ends.
abstract String	getPublicId() Return the public identifier for the current document event.
abstract String	getSystemId() Return the system identifier for the current document event.

Public Constructors

public LocatorImpl ()

Zero-argument constructor.

This will not normally be useful, since the main purpose of this class is to make a snapshot of an existing Locator.

public LocatorImpl (Locator locator)

Copy constructor.

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).

Parameters

locator	The locator to copy.

Public Methods

public int getColumnNumber ()

Return the saved column number (1-based).

Returns

• The column number as an integer, or -1 if none is available.

See Also

• Locator.getColumnNumber()
• setColumnNumber(int)

public int getLineNumber ()

Return the saved line number (1-based).

Returns

• The line number as an integer, or -1 if none is available.

See Also

• Locator.getLineNumber()
• setLineNumber(int)

public String getPublicId ()

Return the saved public identifier.

Returns

• The public identifier as a string, or null if none is available.

See Also

• Locator.getPublicId()
• setPublicId(String)

public String getSystemId ()

Return the saved system identifier.

Returns

• The system identifier as a string, or null if none is available.

See Also

• Locator.getSystemId()
• setSystemId(String)

public void setColumnNumber (int columnNumber)

Set the column number for this locator (1-based).

Parameters

columnNumber	The column number, or -1 if none is available.

See Also

• getColumnNumber()

public void setLineNumber (int lineNumber)

Set the line number for this locator (1-based).

Parameters

lineNumber	The line number, or -1 if none is available.

See Also

• getLineNumber()

public void setPublicId (String publicId)

Set the public identifier for this locator.

Parameters

publicId	The new public identifier, or null if none is available.

See Also

• getPublicId()

public void setSystemId (String systemId)

Set the system identifier for this locator.

Parameters

systemId	The new system identifier, or null if none is available.

See Also

• getSystemId()