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/tools/internal/xjc/reader/internalizer/InternalizationLogic.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,94 @@
     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.tools.internal.xjc.reader.internalizer;
    1.30 +
    1.31 +import org.w3c.dom.Element;
    1.32 +import org.xml.sax.helpers.XMLFilterImpl;
    1.33 +
    1.34 +/**
    1.35 + * Encapsulates schema-language dependent internalization logic.
    1.36 + *
    1.37 + * {@link Internalizer} and {@link DOMForest} are responsible for
    1.38 + * doing schema language independent part, and this object is responsible
    1.39 + * for schema language dependent part.
    1.40 + *
    1.41 + * @author
    1.42 + *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
    1.43 + */
    1.44 +public interface InternalizationLogic {
    1.45 +    /**
    1.46 +     * Creates a new instance of XMLFilter that can be used to
    1.47 +     * find references to external schemas.
    1.48 +     *
    1.49 +     * <p>
    1.50 +     * Schemas that are included/imported need to be a part of
    1.51 +     * {@link DOMForest}, and this filter will be expected to
    1.52 +     * find such references.
    1.53 +     *
    1.54 +     * <p>
    1.55 +     * Once such a reference is found, the filter is expected to
    1.56 +     * call the parse method of DOMForest.
    1.57 +     *
    1.58 +     * <p>
    1.59 +     * {@link DOMForest} will register ErrorHandler to the returned
    1.60 +     * object, so any error should be sent to that error handler.
    1.61 +     *
    1.62 +     * @return
    1.63 +     *      This method returns {@link XMLFilterImpl} because
    1.64 +     *      the filter has to be usable for two directions
    1.65 +     *      (wrapping a reader and wrapping a ContentHandler)
    1.66 +     */
    1.67 +    XMLFilterImpl createExternalReferenceFinder( DOMForest parent );
    1.68 +
    1.69 +    /**
    1.70 +     * Checks if the specified element is a valid target node
    1.71 +     * to attach a customization.
    1.72 +     *
    1.73 +     * @param parent
    1.74 +     *      The owner DOMForest object. Probably useful only
    1.75 +     *      to obtain context information, such as error handler.
    1.76 +     * @param bindings
    1.77 +     *      &lt;jaxb:bindings> element or a customization element.
    1.78 +     * @return
    1.79 +     *      true if it's OK, false if not.
    1.80 +     */
    1.81 +    boolean checkIfValidTargetNode( DOMForest parent, Element bindings, Element target );
    1.82 +
    1.83 +    /**
    1.84 +     * Prepares an element that actually receives customizations.
    1.85 +     *
    1.86 +     * <p>
    1.87 +     * For example, in XML Schema, target nodes can be any schema
    1.88 +     * element but it is always the &lt;xsd:appinfo> element that
    1.89 +     * receives customization.
    1.90 +     *
    1.91 +     * @param target
    1.92 +     *      The target node designated by the customization.
    1.93 +     * @return
    1.94 +     *      Always return non-null valid object
    1.95 +     */
    1.96 +    Element refineTarget( Element target );
    1.97 +}