1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.bind;
  27 
  28 import javax.xml.bind.ValidationEventLocator;
  29 
  30 /**
  31  * Defines additional accessor methods for the event source location.
  32  * <p>
  33  * This interface exposes the location information only available
  34  * in the JAXB RI specific extension.
  35  * <p>
  36  * <em>DO NOT IMPLEMENT THIS INTERFACE BY YOUR CODE</em> because
  37  * we might add more methods on this interface in the future release
  38  * of the RI.
  39  *
  40  * <h2>Usage</h2>
  41  * <p>
  42  * If you obtain a reference to {@link javax.xml.bind.ValidationEventLocator},
  43  * check if you can cast it to {@link ValidationEventLocatorEx} first, like this:
  44  * <pre>
  45  * void foo( ValidationEvent e ) {
  46  *     ValidationEventLocator loc = e.getLocator();
  47  *     if( loc instanceof ValidationEventLocatorEx ) {
  48  *         String fieldName = ((ValidationEventLocatorEx)loc).getFieldName();
  49  *         if( fieldName!=null ) {
  50  *             // do something with location.
  51  *         }
  52  *     }
  53  * }
  54  * </pre>
  55  *
  56  * @author
  57  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  58  */
  59 public interface ValidationEventLocatorEx extends ValidationEventLocator {
  60     /**
  61      * Returns the field name of the object where the error occured.
  62      * <p>
  63      * This method always returns null when you are doing
  64      * a validation during unmarshalling.
  65      *
  66      * When not null, the field name indicates the field of the object
  67      * designated by the {@link #getObject()} method where the error
  68      * occured.
  69      */
  70     String getFieldName();
  71 }