EclipseLink 2.2.0, build 'v20110202-r8913' API Reference

javax.xml.bind.helpers
Class ValidationEventLocatorImpl

java.lang.Object
  extended by javax.xml.bind.helpers.ValidationEventLocatorImpl
All Implemented Interfaces:
ValidationEventLocator

public class ValidationEventLocatorImpl
extends java.lang.Object
implements ValidationEventLocator

Default implementation of the ValidationEventLocator interface.

JAXB providers are allowed to use whatever class that implements the ValidationEventLocator interface. This class is just provided for a convenience.

See Also:
Validator, ValidationEventHandler, ValidationEvent, ValidationEventLocator
Author:
Since:
JAXB1.0

Constructor Summary
ValidationEventLocatorImpl()
          Creates an object with all fields unavailable.
ValidationEventLocatorImpl(org.xml.sax.Locator loc)
          Constructs an object from an org.xml.sax.Locator.
ValidationEventLocatorImpl(org.w3c.dom.Node _node)
          Constructs an object that points to a DOM Node.
ValidationEventLocatorImpl(java.lang.Object _object)
          Constructs an object that points to a JAXB content object.
ValidationEventLocatorImpl(org.xml.sax.SAXParseException e)
          Constructs an object from the location information of a SAXParseException.
 
Method Summary
 int getColumnNumber()
          Return the column number if available
 int getLineNumber()
          Return the line number if available
 org.w3c.dom.Node getNode()
          Return a reference to the DOM Node if available
 java.lang.Object getObject()
          Return a reference to the object in the Java content tree if available
 int getOffset()
          Return the byte offset if available
 java.net.URL getURL()
          Return the name of the XML source as a URL if available
 void setColumnNumber(int _columnNumber)
          Set the columnNumber field on this event locator.
 void setLineNumber(int _lineNumber)
          Set the lineNumber field on this event locator.
 void setNode(org.w3c.dom.Node _node)
          Set the Node field on this event locator.
 void setObject(java.lang.Object _object)
          Set the Object field on this event locator.
 void setOffset(int _offset)
          Set the offset field on this event locator.
 void setURL(java.net.URL _url)
          Set the URL field on this event locator.
 java.lang.String toString()
          Returns a string representation of this object in a format helpful to debugging.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ValidationEventLocatorImpl

public ValidationEventLocatorImpl()
Creates an object with all fields unavailable.


ValidationEventLocatorImpl

public ValidationEventLocatorImpl(org.xml.sax.Locator loc)
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:
java.lang.IllegalArgumentException - if the Locator is null

ValidationEventLocatorImpl

public ValidationEventLocatorImpl(org.xml.sax.SAXParseException e)
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:
java.lang.IllegalArgumentException - if the SAXParseException is null

ValidationEventLocatorImpl

public ValidationEventLocatorImpl(org.w3c.dom.Node _node)
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:
java.lang.IllegalArgumentException - if the Node is null

ValidationEventLocatorImpl

public ValidationEventLocatorImpl(java.lang.Object _object)
Constructs an object that points to a JAXB 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:
java.lang.IllegalArgumentException - if the Object is null
Method Detail

getURL

public java.net.URL getURL()
Description copied from interface: ValidationEventLocator
Return the name of the XML source as a URL if available

Specified by:
getURL in interface ValidationEventLocator
Returns:
the name of the XML source as a URL or null if unavailable
See Also:
ValidationEventLocator.getURL()

setURL

public void setURL(java.net.URL _url)
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 interface ValidationEventLocator
Returns:
the byte offset into the input source or -1 if unavailable
See Also:
ValidationEventLocator.getOffset()

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 interface ValidationEventLocator
Returns:
the line number or -1 if unavailable
See Also:
ValidationEventLocator.getLineNumber()

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 interface ValidationEventLocator
Returns:
the column number or -1 if unavailable
See Also:
ValidationEventLocator.getColumnNumber()

setColumnNumber

public void setColumnNumber(int _columnNumber)
Set the columnNumber field on this event locator.

Parameters:
_columnNumber - the column number

getObject

public java.lang.Object getObject()
Description copied from interface: ValidationEventLocator
Return a reference to the object in the Java content tree if available

Specified by:
getObject in interface ValidationEventLocator
Returns:
a reference to the object in the Java content tree or null if unavailable
See Also:
ValidationEventLocator.getObject()

setObject

public void setObject(java.lang.Object _object)
Set the Object field on this event locator. Null values are allowed.

Parameters:
_object - the java content object

getNode

public org.w3c.dom.Node getNode()
Description copied from interface: ValidationEventLocator
Return a reference to the DOM Node if available

Specified by:
getNode in interface ValidationEventLocator
Returns:
a reference to the DOM Node or null if unavailable
See Also:
ValidationEventLocator.getNode()

setNode

public void setNode(org.w3c.dom.Node _node)
Set the Node field on this event locator. Null values are allowed.

Parameters:
_node - the Node

toString

public java.lang.String toString()
Returns a string representation of this object in a format helpful to debugging.

Overrides:
toString in class java.lang.Object
See Also:
Object.equals(Object)

EclipseLink 2.2.0, build 'v20110202-r8913' API Reference