01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.xml.internal.bind.v2.runtime.property;
27:
28: import javax.xml.namespace.QName;
29:
30: import com.sun.xml.internal.bind.v2.util.QNameMap;
31: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.ChildLoader;
32: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.Loader;
33: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.StructureLoader;
34: import com.sun.xml.internal.bind.v2.runtime.unmarshaller.ValuePropertyLoader;
35:
36: /**
37: * Component that contributes element unmarshallers into
38: * {@link StructureLoader}.
39: *
40: * TODO: think of a better name.
41: *
42: * @author Bhakti Mehta
43: */
44: public interface StructureLoaderBuilder {
45: /**
46: * Every Property class has an implementation of buildChildElementUnmarshallers
47: * which will fill in the specified {@link QNameMap} by elements that are expected
48: * by this property.
49: */
50: void buildChildElementUnmarshallers(UnmarshallerChain chain,
51: QNameMap<ChildLoader> handlers);
52:
53: /**
54: * Magic {@link QName} used to store a handler for the text.
55: *
56: * <p>
57: * To support the mixed content model, {@link StructureLoader} can have
58: * at most one {@link ValuePropertyLoader} for processing text
59: * found amoung elements.
60: *
61: * This special text handler is put into the {@link QNameMap} parameter
62: * of the {@link #buildChildElementUnmarshallers} method by using
63: * this magic token as the key.
64: */
65: public static final QName TEXT_HANDLER = new QName("\u0000", "text");
66:
67: /**
68: * Magic {@link QName} used to store a handler for the rest of the elements.
69: *
70: * <p>
71: * To support the wildcard, {@link StructureLoader} can have
72: * at most one {@link Loader} for processing elements
73: * that didn't match any of the named elements.
74: *
75: * This special text handler is put into the {@link QNameMap} parameter
76: * of the {@link #buildChildElementUnmarshallers} method by using
77: * this magic token as the key.
78: */
79: public static final QName CATCH_ALL = new QName("\u0000",
80: "catchAll");
81: }
|