01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.bind.v2.runtime.property;
38:
39: import javax.xml.namespace.QName;
40:
41: import com.sun.xml.bind.v2.util.QNameMap;
42: import com.sun.xml.bind.v2.runtime.unmarshaller.ChildLoader;
43: import com.sun.xml.bind.v2.runtime.unmarshaller.Loader;
44: import com.sun.xml.bind.v2.runtime.unmarshaller.StructureLoader;
45: import com.sun.xml.bind.v2.runtime.unmarshaller.ValuePropertyLoader;
46:
47: /**
48: * Component that contributes element unmarshallers into
49: * {@link StructureLoader}.
50: *
51: * TODO: think of a better name.
52: *
53: * @author Bhakti Mehta
54: */
55: public interface StructureLoaderBuilder {
56: /**
57: * Every Property class has an implementation of buildChildElementUnmarshallers
58: * which will fill in the specified {@link QNameMap} by elements that are expected
59: * by this property.
60: */
61: void buildChildElementUnmarshallers(UnmarshallerChain chain,
62: QNameMap<ChildLoader> handlers);
63:
64: /**
65: * Magic {@link QName} used to store a handler for the text.
66: *
67: * <p>
68: * To support the mixed content model, {@link StructureLoader} can have
69: * at most one {@link ValuePropertyLoader} for processing text
70: * found amoung elements.
71: *
72: * This special text handler is put into the {@link QNameMap} parameter
73: * of the {@link #buildChildElementUnmarshallers} method by using
74: * this magic token as the key.
75: */
76: public static final QName TEXT_HANDLER = new QName("\u0000", "text");
77:
78: /**
79: * Magic {@link QName} used to store a handler for the rest of the elements.
80: *
81: * <p>
82: * To support the wildcard, {@link StructureLoader} can have
83: * at most one {@link Loader} for processing elements
84: * that didn't match any of the named elements.
85: *
86: * This special text handler is put into the {@link QNameMap} parameter
87: * of the {@link #buildChildElementUnmarshallers} method by using
88: * this magic token as the key.
89: */
90: public static final QName CATCH_ALL = new QName("\u0000",
91: "catchAll");
92: }
|