1/* 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package com.sun.xml.internal.bind.v2.runtime.property; 27 28import javax.xml.namespace.QName; 29 30import com.sun.xml.internal.bind.v2.util.QNameMap; 31import com.sun.xml.internal.bind.v2.runtime.unmarshaller.ChildLoader; 32import com.sun.xml.internal.bind.v2.runtime.unmarshaller.Loader; 33import com.sun.xml.internal.bind.v2.runtime.unmarshaller.StructureLoader; 34import 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 */ 44public 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, QNameMap<ChildLoader> handlers); 51 52 /** 53 * Magic {@link QName} used to store a handler for the text. 54 * 55 * <p> 56 * To support the mixed content model, {@link StructureLoader} can have 57 * at most one {@link ValuePropertyLoader} for processing text 58 * found amoung elements. 59 * 60 * This special text handler is put into the {@link QNameMap} parameter 61 * of the {@link #buildChildElementUnmarshallers} method by using 62 * this magic token as the key. 63 */ 64 public static final QName TEXT_HANDLER = new QName("\u0000","text"); 65 66 /** 67 * Magic {@link QName} used to store a handler for the rest of the elements. 68 * 69 * <p> 70 * To support the wildcard, {@link StructureLoader} can have 71 * at most one {@link Loader} for processing elements 72 * that didn't match any of the named elements. 73 * 74 * This special text handler is put into the {@link QNameMap} parameter 75 * of the {@link #buildChildElementUnmarshallers} method by using 76 * this magic token as the key. 77 */ 78 public static final QName CATCH_ALL = new QName("\u0000","catchAll"); 79} 80