325N/A/*
325N/A * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A/*
325N/A * Copyright (C) 2004-2011
325N/A *
325N/A * Permission is hereby granted, free of charge, to any person obtaining a copy
325N/A * of this software and associated documentation files (the "Software"), to deal
325N/A * in the Software without restriction, including without limitation the rights
325N/A * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
325N/A * copies of the Software, and to permit persons to whom the Software is
325N/A * furnished to do so, subject to the following conditions:
325N/A *
325N/A * The above copyright notice and this permission notice shall be included in
325N/A * all copies or substantial portions of the Software.
325N/A *
325N/A * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
325N/A * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
325N/A * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
325N/A * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
325N/A * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
325N/A * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
325N/A * THE SOFTWARE.
325N/A */
325N/Apackage com.sun.xml.internal.rngom.ast.builder;
325N/A
325N/Aimport com.sun.xml.internal.rngom.ast.om.Location;
325N/Aimport com.sun.xml.internal.rngom.ast.om.ParsedElementAnnotation;
325N/Aimport com.sun.xml.internal.rngom.ast.om.ParsedPattern;
325N/A
325N/A/**
325N/A * The container that can have <define> elements.
325N/A * <p>
325N/A * {@link Div}, {@link Grammar}, {@link Include}, or {@link IncludedGrammar}.
325N/A */
325N/Apublic interface GrammarSection<
325N/A P extends ParsedPattern,
325N/A E extends ParsedElementAnnotation,
325N/A L extends Location,
325N/A A extends Annotations<E,L,CL>,
325N/A CL extends CommentList<L>> {
325N/A
325N/A static final class Combine {
325N/A private final String name;
325N/A private Combine(String name) {
325N/A this.name = name;
325N/A }
325N/A final public String toString() {
325N/A return name;
325N/A }
325N/A }
325N/A
325N/A static final Combine COMBINE_CHOICE = new Combine("choice");
325N/A static final Combine COMBINE_INTERLEAVE = new Combine("interleave");
325N/A
325N/A // using \u0000 guarantees that the name will be never used as
325N/A // a user-defined pattern name.
325N/A static final String START = "\u0000#start\u0000";
325N/A
325N/A /**
325N/A * Called when a pattern is defined.
325N/A *
325N/A * @param name
325N/A * Name of the pattern. For the definition by a &lt;start/> element,
325N/A * this parameter is the same as {@link #START}.
325N/A * to test if it's a named pattern definition or the start pattern definition.
325N/A * @param combine
325N/A * null or {@link #COMBINE_CHOICE} or {@link #COMBINE_INTERLEAVE} depending
325N/A * on the value of the combine attribute.
325N/A * @param pattern
325N/A * The pattern to be defined.
325N/A */
325N/A void define( String name, Combine combine, P pattern, L loc, A anno) throws BuildException;
325N/A
325N/A /**
325N/A * Called when an annotation is found.
325N/A */
325N/A void topLevelAnnotation(E ea) throws BuildException;
325N/A
325N/A /**
325N/A * Called when a comment is found.
325N/A */
325N/A void topLevelComment(CL comments) throws BuildException;
325N/A
325N/A /**
325N/A * Called when &lt;div> is found.
325N/A *
325N/A * @return
325N/A * the returned {@link Div} object will receive callbacks for structures
325N/A * inside the &lt;div> element.
325N/A */
325N/A Div<P,E,L,A,CL> makeDiv();
325N/A
325N/A /**
325N/A * Returns null if already in an include.
325N/A */
325N/A Include<P,E,L,A,CL> makeInclude();
325N/A}