APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xml.internal.utils

public Class SAXSourceLocator

extends LocatorImpl
implements SourceLocator, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, javax.xml.transform.SourceLocator
Imports
java.io.Serializable, javax.xml.transform.SourceLocator, org.xml.sax.Locator, .SAXParseException, org.xml.sax.helpers.LocatorImpl

Class SAXSourceLocator extends org.xml.sax.helpers.LocatorImpl for the purpose of implementing the SourceLocator interface, and thus can be both a SourceLocator and a SAX Locator.

Field Summary

Modifier and TypeField and Description
pack-priv Locator
m_locator

The SAX Locator object.

pack-priv static final long

Constructor Summary

AccessConstructor and Description
public
SAXSourceLocator()

Constructor SAXSourceLocator

public
SAXSourceLocator(Locator
Source locator
locator
)

Constructor SAXSourceLocator

public
SAXSourceLocator(SourceLocator
Source locator
locator
)

Constructor SAXSourceLocator

public
SAXSourceLocator(SAXParseException
SAXParseException exception.
spe
)

Constructor SAXSourceLocator

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The column number, or -1 if none is available.
getColumnNumber
()

Overrides org.xml.sax.helpers.LocatorImpl.getColumnNumber.

Implements javax.xml.transform.SourceLocator.getColumnNumber, org.xml.sax.Locator.getColumnNumber.

Return the column number where the current document event ends.

public int

Returns:

The line number, or -1 if none is available.
getLineNumber
()

Overrides org.xml.sax.helpers.LocatorImpl.getLineNumber.

Implements javax.xml.transform.SourceLocator.getLineNumber, org.xml.sax.Locator.getLineNumber.

Return the line number where the current document event ends.

public String

Returns:

A string containing the public identifier, or null if none is available.
getPublicId
()

Overrides org.xml.sax.helpers.LocatorImpl.getPublicId.

Implements javax.xml.transform.SourceLocator.getPublicId, org.xml.sax.Locator.getPublicId.

Return the public identifier for the current document event.

public String

Returns:

A string containing the system identifier, or null if none is available.
getSystemId
()

Overrides org.xml.sax.helpers.LocatorImpl.getSystemId.

Implements javax.xml.transform.SourceLocator.getSystemId, org.xml.sax.Locator.getSystemId.

Return the system identifier for the current document event.

Inherited from org.xml.sax.helpers.LocatorImpl:
setColumnNumbersetLineNumbersetPublicIdsetSystemId

Field Detail

m_locatorback to summary
pack-priv Locator m_locator

The SAX Locator object.

Annotations
@SuppressWarnings:serial
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Constructor Detail

SAXSourceLocatorback to summary
public SAXSourceLocator()

Constructor SAXSourceLocator

SAXSourceLocatorback to summary
public SAXSourceLocator(Locator locator)

Constructor SAXSourceLocator

Parameters
locator:Locator

Source locator

SAXSourceLocatorback to summary
public SAXSourceLocator(SourceLocator locator)

Constructor SAXSourceLocator

Parameters
locator:SourceLocator

Source locator

SAXSourceLocatorback to summary
public SAXSourceLocator(SAXParseException spe)

Constructor SAXSourceLocator

Parameters
spe:SAXParseException

SAXParseException exception.

Method Detail

getColumnNumberback to summary
public int getColumnNumber()

Overrides org.xml.sax.helpers.LocatorImpl.getColumnNumber.

Implements javax.xml.transform.SourceLocator.getColumnNumber, org.xml.sax.Locator.getColumnNumber.

Return the column number where the current document event ends.

Warning

The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

Returns:int

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

See Also
getLineNumber
getLineNumberback to summary
public int getLineNumber()

Overrides org.xml.sax.helpers.LocatorImpl.getLineNumber.

Implements javax.xml.transform.SourceLocator.getLineNumber, org.xml.sax.Locator.getLineNumber.

Return the line number where the current document event ends.

Warning

The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

Returns:int

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

See Also
getColumnNumber
getPublicIdback to summary
public String getPublicId()

Overrides org.xml.sax.helpers.LocatorImpl.getPublicId.

Implements javax.xml.transform.SourceLocator.getPublicId, org.xml.sax.Locator.getPublicId.

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

Returns:String

A string containing the public identifier, or null if none is available.

See Also
getSystemId
getSystemIdback to summary
public String getSystemId()

Overrides org.xml.sax.helpers.LocatorImpl.getSystemId.

Implements javax.xml.transform.SourceLocator.getSystemId, org.xml.sax.Locator.getSystemId.

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Returns:String

A string containing the system identifier, or null if none is available.

See Also
getPublicId