01: /*
02: * @(#)$Id: ValidationEventLocatorEx.java,v 1.2.6.1 2007/05/31 21:58:52 ofung Exp $
03: */
04:
05: /*
06: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
07: *
08: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
09: *
10: * The contents of this file are subject to the terms of either the GNU
11: * General Public License Version 2 only ("GPL") or the Common Development
12: * and Distribution License("CDDL") (collectively, the "License"). You
13: * may not use this file except in compliance with the License. You can obtain
14: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16: * language governing permissions and limitations under the License.
17: *
18: * When distributing the software, include this License Header Notice in each
19: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20: * Sun designates this particular file as subject to the "Classpath" exception
21: * as provided by Sun in the GPL Version 2 section of the License file that
22: * accompanied this code. If applicable, add the following below the License
23: * Header, with the fields enclosed by brackets [] replaced by your own
24: * identifying information: "Portions Copyrighted [year]
25: * [name of copyright owner]"
26: *
27: * Contributor(s):
28: *
29: * If you wish your version of this file to be governed by only the CDDL or
30: * only the GPL Version 2, indicate your decision by adding "[Contributor]
31: * elects to include this software in this distribution under the [CDDL or GPL
32: * Version 2] license." If you don't indicate a single choice of license, a
33: * recipient has the option to distribute your version of this file under
34: * either the CDDL, the GPL Version 2 or to extend the choice of license to
35: * its licensees as provided above. However, if you add GPL Version 2 code
36: * and therefore, elected the GPL Version 2 license, then the option applies
37: * only if the new code is made subject to such option by the copyright
38: * holder.
39: */
40: package com.sun.xml.bind;
41:
42: import javax.xml.bind.ValidationEventLocator;
43:
44: /**
45: * Defines additional accessor methods for the event source location.
46: * <p>
47: * This interface exposes the location information only available
48: * in the JAXB RI specific extension.
49: * <p>
50: * <em>DO NOT IMPLEMENT THIS INTERFACE BY YOUR CODE</em> because
51: * we might add more methods on this interface in the future release
52: * of the RI.
53: *
54: * <h2>Usage</h2>
55: * <p>
56: * If you obtain a reference to {@link javax.xml.bind.ValidationEventLocator},
57: * check if you can cast it to {@link ValidationEventLocatorEx} first, like this:
58: * <pre>
59: * void foo( ValidationEvent e ) {
60: * ValidationEventLocator loc = e.getLocator();
61: * if( loc instanceof ValidationEventLocatorEx ) {
62: * String fieldName = ((ValidationEventLocatorEx)loc).getFieldName();
63: * if( fieldName!=null ) {
64: * // do something with location.
65: * }
66: * }
67: * }
68: * </pre>
69: *
70: * @author
71: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
72: */
73: public interface ValidationEventLocatorEx extends
74: ValidationEventLocator {
75: /**
76: * Returns the field name of the object where the error occured.
77: * <p>
78: * This method always returns null when you are doing
79: * a validation during unmarshalling.
80: *
81: * When not null, the field name indicates the field of the object
82: * designated by the {@link #getObject()} method where the error
83: * occured.
84: */
85: String getFieldName();
86: }
|