aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind;
aoqi@0: 
aoqi@0: import javax.xml.bind.ValidationEventLocator;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Defines additional accessor methods for the event source location.
aoqi@0:  * <p>
aoqi@0:  * This interface exposes the location information only available
aoqi@0:  * in the JAXB RI specific extension.
aoqi@0:  * <p>
aoqi@0:  * <em>DO NOT IMPLEMENT THIS INTERFACE BY YOUR CODE</em> because
aoqi@0:  * we might add more methods on this interface in the future release
aoqi@0:  * of the RI.
aoqi@0:  *
aoqi@0:  * <h2>Usage</h2>
aoqi@0:  * <p>
aoqi@0:  * If you obtain a reference to {@link javax.xml.bind.ValidationEventLocator},
aoqi@0:  * check if you can cast it to {@link ValidationEventLocatorEx} first, like this:
aoqi@0:  * <pre>
aoqi@0:  * void foo( ValidationEvent e ) {
aoqi@0:  *     ValidationEventLocator loc = e.getLocator();
aoqi@0:  *     if( loc instanceof ValidationEventLocatorEx ) {
aoqi@0:  *         String fieldName = ((ValidationEventLocatorEx)loc).getFieldName();
aoqi@0:  *         if( fieldName!=null ) {
aoqi@0:  *             // do something with location.
aoqi@0:  *         }
aoqi@0:  *     }
aoqi@0:  * }
aoqi@0:  * </pre>
aoqi@0:  *
aoqi@0:  * @author
aoqi@0:  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
aoqi@0:  */
aoqi@0: public interface ValidationEventLocatorEx extends ValidationEventLocator {
aoqi@0:     /**
aoqi@0:      * Returns the field name of the object where the error occured.
aoqi@0:      * <p>
aoqi@0:      * This method always returns null when you are doing
aoqi@0:      * a validation during unmarshalling.
aoqi@0:      *
aoqi@0:      * When not null, the field name indicates the field of the object
aoqi@0:      * designated by the {@link #getObject()} method where the error
aoqi@0:      * occured.
aoqi@0:      */
aoqi@0:     String getFieldName();
aoqi@0: }