Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/bind/ValidationEventLocatorEx.java	Wed Apr 27 01:27:09 2016 +0800
     1.3 @@ -0,0 +1,71 @@
     1.4 +/*
     1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.xml.internal.bind;
    1.30 +
    1.31 +import javax.xml.bind.ValidationEventLocator;
    1.32 +
    1.33 +/**
    1.34 + * Defines additional accessor methods for the event source location.
    1.35 + * <p>
    1.36 + * This interface exposes the location information only available
    1.37 + * in the JAXB RI specific extension.
    1.38 + * <p>
    1.39 + * <em>DO NOT IMPLEMENT THIS INTERFACE BY YOUR CODE</em> because
    1.40 + * we might add more methods on this interface in the future release
    1.41 + * of the RI.
    1.42 + *
    1.43 + * <h2>Usage</h2>
    1.44 + * <p>
    1.45 + * If you obtain a reference to {@link javax.xml.bind.ValidationEventLocator},
    1.46 + * check if you can cast it to {@link ValidationEventLocatorEx} first, like this:
    1.47 + * <pre>
    1.48 + * void foo( ValidationEvent e ) {
    1.49 + *     ValidationEventLocator loc = e.getLocator();
    1.50 + *     if( loc instanceof ValidationEventLocatorEx ) {
    1.51 + *         String fieldName = ((ValidationEventLocatorEx)loc).getFieldName();
    1.52 + *         if( fieldName!=null ) {
    1.53 + *             // do something with location.
    1.54 + *         }
    1.55 + *     }
    1.56 + * }
    1.57 + * </pre>
    1.58 + *
    1.59 + * @author
    1.60 + *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
    1.61 + */
    1.62 +public interface ValidationEventLocatorEx extends ValidationEventLocator {
    1.63 +    /**
    1.64 +     * Returns the field name of the object where the error occured.
    1.65 +     * <p>
    1.66 +     * This method always returns null when you are doing
    1.67 +     * a validation during unmarshalling.
    1.68 +     *
    1.69 +     * When not null, the field name indicates the field of the object
    1.70 +     * designated by the {@link #getObject()} method where the error
    1.71 +     * occured.
    1.72 +     */
    1.73 +    String getFieldName();
    1.74 +}