- All Implemented Interfaces:
ValidationEventLocator
Jakarta XML Binding providers are allowed to use whatever class that implements the ValidationEventLocator interface. This class is just provided for a convenience.
- Author:
- Kohsuke Kawaguchi, Sun Microsystems, Inc.
- See Also:
-
Constructor Summary
ConstructorDescriptionCreates an object with all fields unavailable.ValidationEventLocatorImpl
(Object _object) Constructs an object that points to a Jakarta XML Binding content object.ValidationEventLocatorImpl
(Node _node) Constructs an object that points to a DOM Node.Constructs an object from an org.xml.sax.Locator.Constructs an object from the location information of a SAXParseException. -
Method Summary
Modifier and TypeMethodDescriptionint
Return the column number if availableint
Return the line number if availablegetNode()
Return a reference to the DOM Node if availableReturn a reference to the object in the Java content tree if availableint
Return the byte offset if availablegetURL()
Return the name of the XML source as a URL if availablevoid
setColumnNumber
(int _columnNumber) Set the columnNumber field on this event locator.void
setLineNumber
(int _lineNumber) Set the lineNumber field on this event locator.void
Set the Node field on this event locator.void
Set the Object field on this event locator.void
setOffset
(int _offset) Set the offset field on this event locator.void
Set the URL field on this event locator.toString()
Returns a string representation of this object in a format helpful to debugging.
-
Constructor Details
-
ValidationEventLocatorImpl
public ValidationEventLocatorImpl()Creates an object with all fields unavailable. -
ValidationEventLocatorImpl
Constructs an object from an org.xml.sax.Locator.The object's ColumnNumber, LineNumber, and URL become available from the values returned by the locator's getColumnNumber(), getLineNumber(), and getSystemId() methods respectively. Node, Object, and Offset are not available.
- Parameters:
loc
- the SAX Locator object that will be used to populate this event locator.- Throws:
IllegalArgumentException
- if the Locator is null
-
ValidationEventLocatorImpl
Constructs an object from the location information of a SAXParseException.The object's ColumnNumber, LineNumber, and URL become available from the values returned by the locator's getColumnNumber(), getLineNumber(), and getSystemId() methods respectively. Node, Object, and Offset are not available.
- Parameters:
e
- the SAXParseException object that will be used to populate this event locator.- Throws:
IllegalArgumentException
- if the SAXParseException is null
-
ValidationEventLocatorImpl
Constructs an object that points to a DOM Node.The object's Node becomes available. ColumnNumber, LineNumber, Object, Offset, and URL are not available.
- Parameters:
_node
- the DOM Node object that will be used to populate this event locator.- Throws:
IllegalArgumentException
- if the Node is null
-
ValidationEventLocatorImpl
Constructs an object that points to a Jakarta XML Binding content object.The object's Object becomes available. ColumnNumber, LineNumber, Node, Offset, and URL are not available.
- Parameters:
_object
- the Object that will be used to populate this event locator.- Throws:
IllegalArgumentException
- if the Object is null
-
-
Method Details
-
getURL
Description copied from interface:ValidationEventLocator
Return the name of the XML source as a URL if available- Specified by:
getURL
in interfaceValidationEventLocator
- Returns:
- the name of the XML source as a URL or null if unavailable
- See Also:
-
setURL
Set the URL field on this event locator. Null values are allowed.- Parameters:
_url
- the url
-
getOffset
public int getOffset()Description copied from interface:ValidationEventLocator
Return the byte offset if available- Specified by:
getOffset
in interfaceValidationEventLocator
- Returns:
- the byte offset into the input source or -1 if unavailable
- See Also:
-
setOffset
public void setOffset(int _offset) Set the offset field on this event locator.- Parameters:
_offset
- the offset
-
getLineNumber
public int getLineNumber()Description copied from interface:ValidationEventLocator
Return the line number if available- Specified by:
getLineNumber
in interfaceValidationEventLocator
- Returns:
- the line number or -1 if unavailable
- See Also:
-
setLineNumber
public void setLineNumber(int _lineNumber) Set the lineNumber field on this event locator.- Parameters:
_lineNumber
- the line number
-
getColumnNumber
public int getColumnNumber()Description copied from interface:ValidationEventLocator
Return the column number if available- Specified by:
getColumnNumber
in interfaceValidationEventLocator
- Returns:
- the column number or -1 if unavailable
- See Also:
-
setColumnNumber
public void setColumnNumber(int _columnNumber) Set the columnNumber field on this event locator.- Parameters:
_columnNumber
- the column number
-
getObject
Description copied from interface:ValidationEventLocator
Return a reference to the object in the Java content tree if available- Specified by:
getObject
in interfaceValidationEventLocator
- Returns:
- a reference to the object in the Java content tree or null if unavailable
- See Also:
-
setObject
Set the Object field on this event locator. Null values are allowed.- Parameters:
_object
- the java content object
-
getNode
Description copied from interface:ValidationEventLocator
Return a reference to the DOM Node if available- Specified by:
getNode
in interfaceValidationEventLocator
- Returns:
- a reference to the DOM Node or null if unavailable
- See Also:
-
setNode
Set the Node field on this event locator. Null values are allowed.- Parameters:
_node
- the Node
-
toString
Returns a string representation of this object in a format helpful to debugging.
-