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.
Locator
| Modifier and Type | Field and Description |
|---|---|
| private int | |
| private int | |
| private String | |
| private String |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public int | Returns: The column number as an integer, or -1 if none is available.Implements org. Return the saved column number (1-based). |
| public int | Returns: The line number as an integer, or -1 if none is available.Implements org. Return the saved line number (1-based). |
| public String | Returns: The public identifier as a string, or null if none is available.Implements org. Return the saved public identifier. |
| public String | Returns: The system identifier as a string, or null if none is available.Implements org. Return the saved system identifier. |
| public void | setColumnNumber(int
The column number, or -1 if none is available. columnNumber)Set the column number for this locator (1-based). |
| public void | setLineNumber(int
The line number, or -1 if none is available. lineNumber)Set the line number for this locator (1-based). |
| public void | setPublicId(String
The new public identifier, or null
if none is available. publicId)Set the public identifier for this locator. |
| public void | setSystemId(String
The new system identifier, or null
if none is available. systemId)Set the system identifier for this locator. |
| columnNumber | back to summary |
|---|---|
| private int columnNumber | |
| lineNumber | back to summary |
|---|---|
| private int lineNumber | |
| publicId | back to summary |
|---|---|
| private String publicId | |
| systemId | back to summary |
|---|---|
| private String systemId | |
| LocatorImpl | back to summary |
|---|---|
| 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 | back to summary |
|---|---|
| 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).
| |
| getColumnNumber | back to summary |
|---|---|
| public int getColumnNumber() Implements org. Return the saved column number (1-based).
| |
| getLineNumber | back to summary |
|---|---|
| public int getLineNumber() Implements org. Return the saved line number (1-based).
| |
| getPublicId | back to summary |
|---|---|
| public String getPublicId() Implements org. Return the saved public identifier.
| |
| getSystemId | back to summary |
|---|---|
| public String getSystemId() Implements org. Return the saved system identifier.
| |
| setColumnNumber | back to summary |
|---|---|
| public void setColumnNumber(int columnNumber) Set the column number for this locator (1-based).
| |
| setLineNumber | back to summary |
|---|---|
| public void setLineNumber(int lineNumber) Set the line number for this locator (1-based).
| |
| setPublicId | back to summary |
|---|---|
| public void setPublicId(String publicId) Set the public identifier for this locator.
| |
| setSystemId | back to summary |
|---|---|
| public void setSystemId(String systemId) Set the system identifier for this locator.
| |