Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.extension.spi
Class LocatorImpl  view LocatorImpl download LocatorImpl.java

java.lang.Object
  extended byjavax.ide.extension.spi.LocatorImpl
All Implemented Interfaces:
org.xml.sax.Locator

final class LocatorImpl
extends java.lang.Object
implements org.xml.sax.Locator


Field Summary
private  int _column
           
private  int _line
           
private  java.lang.String _publicId
           
private  java.lang.String _systemId
           
 
Constructor Summary
LocatorImpl(java.lang.String systemId)
           
LocatorImpl(java.lang.String publicId, java.lang.String systemId)
           
LocatorImpl(java.lang.String publicId, java.lang.String systemId, int column, int line)
           
 
Method Summary
 int getColumnNumber()
          Return the column number where the current document event ends.
 int getLineNumber()
          Return the line number where the current document event ends.
 java.lang.String getPublicId()
          Return the public identifier for the current document event.
 java.lang.String getSystemId()
          Return the system identifier for the current document event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_publicId

private final java.lang.String _publicId

_systemId

private final java.lang.String _systemId

_column

private final int _column

_line

private final int _line
Constructor Detail

LocatorImpl

public LocatorImpl(java.lang.String publicId,
                   java.lang.String systemId,
                   int column,
                   int line)

LocatorImpl

public LocatorImpl(java.lang.String publicId,
                   java.lang.String systemId)

LocatorImpl

public LocatorImpl(java.lang.String systemId)
Method Detail

getColumnNumber

public int getColumnNumber()
Description copied from interface: org.xml.sax.Locator
Return the column number where the current document event ends. This is one-based number of Java char values since the last line end.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

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.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

Specified by:
getColumnNumber in interface org.xml.sax.Locator

getLineNumber

public int getLineNumber()
Description copied from interface: org.xml.sax.Locator
Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

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.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

Specified by:
getLineNumber in interface org.xml.sax.Locator

getPublicId

public java.lang.String getPublicId()
Description copied from interface: org.xml.sax.Locator
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.

Specified by:
getPublicId in interface org.xml.sax.Locator

getSystemId

public java.lang.String getSystemId()
Description copied from interface: org.xml.sax.Locator
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. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases.

Specified by:
getSystemId in interface org.xml.sax.Locator