LocatorImpl
open class LocatorImpl : Locator
kotlin.Any | |
↳ | org.xml.sax.helpers.LocatorImpl |
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.
Summary
Public constructors | |
---|---|
Zero-argument constructor. |
|
LocatorImpl(locator: Locator!) Copy constructor. |
Public methods | |
---|---|
open Int |
Return the saved column number (1-based). |
open Int |
Return the saved line number (1-based). |
open String! |
Return the saved public identifier. |
open String! |
Return the saved system identifier. |
open Unit |
setColumnNumber(columnNumber: Int) Set the column number for this locator (1-based). |
open Unit |
setLineNumber(lineNumber: Int) Set the line number for this locator (1-based). |
open Unit |
setPublicId(publicId: String!) Set the public identifier for this locator. |
open Unit |
setSystemId(systemId: String!) Set the system identifier for this locator. |
Public constructors
LocatorImpl
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.
LocatorImpl
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 |
Locator!: The locator to copy. |
Public methods
getColumnNumber
open fun getColumnNumber(): Int
Return the saved column number (1-based).
Return | |
---|---|
Int |
The column number as an integer, or -1 if none is available. |
getLineNumber
open fun getLineNumber(): Int
Return the saved line number (1-based).
Return | |
---|---|
Int |
The line number as an integer, or -1 if none is available. |
getPublicId
open fun getPublicId(): String!
Return the saved public identifier.
Return | |
---|---|
String! |
The public identifier as a string, or null if none is available. |
getSystemId
open fun getSystemId(): String!
Return the saved system identifier.
Return | |
---|---|
String! |
The system identifier as a string, or null if none is available. |
setColumnNumber
open fun setColumnNumber(columnNumber: Int): Unit
Set the column number for this locator (1-based).
Parameters | |
---|---|
columnNumber |
Int: The column number, or -1 if none is available. |
See Also
setLineNumber
open fun setLineNumber(lineNumber: Int): Unit
Set the line number for this locator (1-based).
Parameters | |
---|---|
lineNumber |
Int: The line number, or -1 if none is available. |
See Also
setPublicId
open fun setPublicId(publicId: String!): Unit
Set the public identifier for this locator.
Parameters | |
---|---|
publicId |
String!: The new public identifier, or null if none is available. |
See Also
setSystemId
open fun setSystemId(systemId: String!): Unit
Set the system identifier for this locator.
Parameters | |
---|---|
systemId |
String!: The new system identifier, or null if none is available. |
See Also