Added in API level 1

LocatorImpl

open class LocatorImpl : Locator

kotlin.Any
↳	org.xml.sax.helpers.LocatorImpl

Known Direct Subclasses

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.

Summary

Public constructors
`LocatorImpl()` Zero-argument constructor.
`LocatorImpl(locator: Locator!)` Copy constructor.

Public methods
open Int	`getColumnNumber()` Return the saved column number (1-based).
open Int	`getLineNumber()` Return the saved line number (1-based).
open String!	`getPublicId()` Return the saved public identifier.
open String!	`getSystemId()` 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

Added in API level 1

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

Added in API level 1

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

Added in API level 1

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.

See Also

getLineNumber

Added in API level 1

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.

See Also

getPublicId

Added in API level 1

open fun getPublicId(): String!

Return the saved public identifier.

Return
`String!`	The public identifier as a string, or null if none is available.

See Also

getSystemId

Added in API level 1

open fun getSystemId(): String!

Return the saved system identifier.

Return
`String!`	The system identifier as a string, or null if none is available.

See Also

setColumnNumber

Added in API level 1

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

#getColumnNumber

setLineNumber

Added in API level 1

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

#getLineNumber

setPublicId

Added in API level 1

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

#getPublicId

setSystemId

Added in API level 1

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

#getSystemId