Top Description Fields Constructors Methods
com.dd.plist

public Class XMLLocationInformation

extends LocationInformation
Class Inheritance
Imports
org.w3c.dom.NamedNodeMap, .Node, org.xml.sax.Locator
Information about the location of an NSObject within an XML property list file.

Line and column number are only available if the withLineInformation parameter in the call to one of the XMLPropertyListParser's parse methods was set to true. The line information is taken from the Locator class and thus is only an approximation of the actual location that can only be used for diagnostic purposes.

Author
Daniel Dreibrodt

Field Summary

Modifier and TypeField and Description
private int
column

private int
lineNo

private final String
xpath

Constructor Summary

AccessConstructor and Description
pack-priv
XMLLocationInformation(Node n, String xpath)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The column (starting at 1), or -1 if the column is not available.
getColumnNumber()

Gets the column number of the end of the XML node's start tag, if available.

public String
getDescription()

Implements abstract com.dd.plist.LocationInformation.getDescription.

Gets a description of the object location.

public int

Returns:

The line number (starting at 1), or -1 if the line number is not available.
getLineNumber()

Gets the line number of the end of the XML node's start tag, if available.

public String

Returns:

The XPath.
getXPath()

Gets the XPath of the XML node that is the source for the NSObject.

public boolean

Returns:

true, if both line and column number are available; false, otherwise.
hasLineInformation()

Gets a value indicating whether line and column number are available.

Inherited from com.dd.plist.LocationInformation:
toString

Field Detail

columnback to summary
private int column
lineNoback to summary
private int lineNo
xpathback to summary
private final String xpath

Constructor Detail

XMLLocationInformationback to summary
pack-priv XMLLocationInformation(Node n, String xpath)

Method Detail

getColumnNumberback to summary
public int getColumnNumber()

Gets the column number of the end of the XML node's start tag, if available.

Returns:int

The column (starting at 1), or -1 if the column is not available.

See Also
Locator#getColumnNumber(), XMLLocationInformation#hasLineInformation()
getDescriptionback to summary
public String getDescription()

Implements abstract com.dd.plist.LocationInformation.getDescription.

Doc from com.dd.plist.LocationInformation.getDescription.

Gets a description of the object location.

Annotations
@Override
getLineNumberback to summary
public int getLineNumber()

Gets the line number of the end of the XML node's start tag, if available.

Returns:int

The line number (starting at 1), or -1 if the line number is not available.

See Also
Locator#getLineNumber(), XMLLocationInformation#hasLineInformation()
getXPathback to summary
public String getXPath()

Gets the XPath of the XML node that is the source for the NSObject.

Returns:String

The XPath.

hasLineInformationback to summary
public boolean hasLineInformation()

Gets a value indicating whether line and column number are available.

Returns:boolean

true, if both line and column number are available; false, otherwise.