Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/internalizer/InternalizationLogic.java@f50545b5e2f1 (annotated)
src/share/jaxws_classes/com/sun/tools/internal/xjc/reader/internalizer/InternalizationLogic.java
Tue, 06 Mar 2012 16:09:35 -0800
- author
- ohair
- date
- Tue, 06 Mar 2012 16:09:35 -0800
- changeset 286
- f50545b5e2f1
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom
| 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.tools.internal.xjc.reader.internalizer; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import org.w3c.dom.Element; |
| aoqi@0 | 29 | import org.xml.sax.helpers.XMLFilterImpl; |
| aoqi@0 | 30 | |
| aoqi@0 | 31 | /** |
| aoqi@0 | 32 | * Encapsulates schema-language dependent internalization logic. |
| aoqi@0 | 33 | * |
| aoqi@0 | 34 | * {@link Internalizer} and {@link DOMForest} are responsible for |
| aoqi@0 | 35 | * doing schema language independent part, and this object is responsible |
| aoqi@0 | 36 | * for schema language dependent part. |
| aoqi@0 | 37 | * |
| aoqi@0 | 38 | * @author |
| aoqi@0 | 39 | * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| aoqi@0 | 40 | */ |
| aoqi@0 | 41 | public interface InternalizationLogic { |
| aoqi@0 | 42 | /** |
| aoqi@0 | 43 | * Creates a new instance of XMLFilter that can be used to |
| aoqi@0 | 44 | * find references to external schemas. |
| aoqi@0 | 45 | * |
| aoqi@0 | 46 | * <p> |
| aoqi@0 | 47 | * Schemas that are included/imported need to be a part of |
| aoqi@0 | 48 | * {@link DOMForest}, and this filter will be expected to |
| aoqi@0 | 49 | * find such references. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * <p> |
| aoqi@0 | 52 | * Once such a reference is found, the filter is expected to |
| aoqi@0 | 53 | * call the parse method of DOMForest. |
| aoqi@0 | 54 | * |
| aoqi@0 | 55 | * <p> |
| aoqi@0 | 56 | * {@link DOMForest} will register ErrorHandler to the returned |
| aoqi@0 | 57 | * object, so any error should be sent to that error handler. |
| aoqi@0 | 58 | * |
| aoqi@0 | 59 | * @return |
| aoqi@0 | 60 | * This method returns {@link XMLFilterImpl} because |
| aoqi@0 | 61 | * the filter has to be usable for two directions |
| aoqi@0 | 62 | * (wrapping a reader and wrapping a ContentHandler) |
| aoqi@0 | 63 | */ |
| aoqi@0 | 64 | XMLFilterImpl createExternalReferenceFinder( DOMForest parent ); |
| aoqi@0 | 65 | |
| aoqi@0 | 66 | /** |
| aoqi@0 | 67 | * Checks if the specified element is a valid target node |
| aoqi@0 | 68 | * to attach a customization. |
| aoqi@0 | 69 | * |
| aoqi@0 | 70 | * @param parent |
| aoqi@0 | 71 | * The owner DOMForest object. Probably useful only |
| aoqi@0 | 72 | * to obtain context information, such as error handler. |
| aoqi@0 | 73 | * @param bindings |
| aoqi@0 | 74 | * <jaxb:bindings> element or a customization element. |
| aoqi@0 | 75 | * @return |
| aoqi@0 | 76 | * true if it's OK, false if not. |
| aoqi@0 | 77 | */ |
| aoqi@0 | 78 | boolean checkIfValidTargetNode( DOMForest parent, Element bindings, Element target ); |
| aoqi@0 | 79 | |
| aoqi@0 | 80 | /** |
| aoqi@0 | 81 | * Prepares an element that actually receives customizations. |
| aoqi@0 | 82 | * |
| aoqi@0 | 83 | * <p> |
| aoqi@0 | 84 | * For example, in XML Schema, target nodes can be any schema |
| aoqi@0 | 85 | * element but it is always the <xsd:appinfo> element that |
| aoqi@0 | 86 | * receives customization. |
| aoqi@0 | 87 | * |
| aoqi@0 | 88 | * @param target |
| aoqi@0 | 89 | * The target node designated by the customization. |
| aoqi@0 | 90 | * @return |
| aoqi@0 | 91 | * Always return non-null valid object |
| aoqi@0 | 92 | */ |
| aoqi@0 | 93 | Element refineTarget( Element target ); |
| aoqi@0 | 94 | } |
