Locator2Impl

AI-generated Key Takeaways

• Locator2Impl is a helper class extending LocatorImpl and implementing Locator2 to manage additional entity information in SAX2.

• It is a SAX2 extension and not included in core-only SAX2 distributions; source code and documentation are in the Public Domain.

• The class provides constructors to create a new Locator2Impl object and to copy from an existing Locator or Locator2 object.

• It offers methods to retrieve and set the encoding and XML version properties of the entity.

• Inherits methods from LocatorImpl and Object for accessing and modifying locator information like column number, line number, public ID, and system ID.

public class Locator2Impl extends LocatorImpl
implements Locator2

SAX2 extension helper for holding additional Entity information, implementing the Locator2 interface.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is not part of core-only SAX2 distributions.

Public Constructor Summary

	Locator2Impl() Construct a new, empty Locator2Impl object.
	Locator2Impl(Locator locator) Copy an existing Locator or Locator2 object.

Public Method Summary

String	getEncoding() Returns the current value of the encoding property.
String	getXMLVersion() Returns the current value of the version property.
void	setEncoding(String encoding) Assigns the current value of the encoding property.
void	setXMLVersion(String version) Assigns the current value of the version property.

Inherited Method Summary

From class org.xml.sax.helpers.LocatorImpl

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.

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.

From interface org.xml.sax.ext.Locator2

abstract String	getEncoding() Returns the name of the character encoding for the entity.
abstract String	getXMLVersion() Returns the version of XML used for the entity.

Public Constructors

public Locator2Impl ()

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

public Locator2Impl (Locator locator)

Copy an existing Locator or Locator2 object. If the object implements Locator2, values of the encoding and versionstrings are copied, otherwise they set to null.

Parameters

locator	The existing Locator object.

Public Methods

public String getEncoding ()

Returns the current value of the encoding property.

Returns

• the current value of the encoding property.

See Also

• setEncoding(String)

public String getXMLVersion ()

Returns the current value of the version property.

Returns

• the current value of the version property.

See Also

• setXMLVersion(String)

public void setEncoding (String encoding)

Assigns the current value of the encoding property.

Parameters

encoding	the new "encoding" value

See Also

• getEncoding()

public void setXMLVersion (String version)

Assigns the current value of the version property.

Parameters

version	the new "version" value

See Also

• getXMLVersion()