LocatorImpl
public
class
LocatorImpl
extends Object
implements
Locator
java.lang.Object | |
↳ | 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.
See also:
Summary
Public constructors | |
---|---|
LocatorImpl()
Zero-argument constructor. |
|
LocatorImpl(Locator locator)
Copy constructor. |
Public methods | |
---|---|
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 methods | |
---|---|
Public constructors
LocatorImpl
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.
LocatorImpl
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 |
Locator : The locator to copy. |
Public methods
getColumnNumber
public int getColumnNumber ()
Return the saved column number (1-based).
Returns | |
---|---|
int |
The column number as an integer, or -1 if none is available. |
getLineNumber
public int getLineNumber ()
Return the saved line number (1-based).
Returns | |
---|---|
int |
The line number as an integer, or -1 if none is available. |
getPublicId
public String getPublicId ()
Return the saved public identifier.
Returns | |
---|---|
String |
The public identifier as a string, or null if none is available. |
See also:
getSystemId
public String getSystemId ()
Return the saved system identifier.
Returns | |
---|---|
String |
The system identifier as a string, or null if none is available. |
See also:
setColumnNumber
public void setColumnNumber (int columnNumber)
Set the column number for this locator (1-based).
Parameters | |
---|---|
columnNumber |
int : The column number, or -1 if none is available. |
See also:
setLineNumber
public void setLineNumber (int lineNumber)
Set the line number for this locator (1-based).
Parameters | |
---|---|
lineNumber |
int : The line number, or -1 if none is available. |
See also:
setPublicId
public void setPublicId (String publicId)
Set the public identifier for this locator.
Parameters | |
---|---|
publicId |
String : The new public identifier, or null
if none is available. |
See also:
setSystemId
public void setSystemId (String systemId)
Set the system identifier for this locator.
Parameters | |
---|---|
systemId |
String : The new system identifier, or null
if none is available. |
See also: