com.sun.xml.bind

Interface ValidationEventLocatorEx

All Superinterfaces:

ValidationEventLocator

All Known Implementing Classes:

ValidationEventLocatorExImpl

public interface ValidationEventLocatorEx
extends ValidationEventLocator

Defines additional accessor methods for the event source location.

This interface exposes the location information only available in the JAXB RI specific extension.

DO NOT IMPLEMENT THIS INTERFACE BY YOUR CODE because we might add more methods on this interface in the future release of the RI.

Usage

If you obtain a reference to ValidationEventLocator, check if you can cast it to ValidationEventLocatorEx first, like this:

 void foo( ValidationEvent e ) {
     ValidationEventLocator loc = e.getLocator();
     if( loc instanceof ValidationEventLocatorEx ) {
         String fieldName = ((ValidationEventLocatorEx)loc).getFieldName();
         if( fieldName!=null ) {
             // do something with location.
         }
     }
 }
 

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Returns the field name of the object where the error occured.

Methods inherited from interface javax.xml.bind.ValidationEventLocator

getColumnNumber, getLineNumber, getNode, getObject, getOffset, getURL

Method Detail

getFieldName

String getFieldName()

Returns the field name of the object where the error occured.

This method always returns null when you are doing a validation during unmarshalling. When not null, the field name indicates the field of the object designated by the ValidationEventLocator.getObject() method where the error occured.