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