1 /*
   2  * Copyright (c) 2005, 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 /*
  26  * Copyright (C) 2004-2011
  27  *
  28  * Permission is hereby granted, free of charge, to any person obtaining a copy
  29  * of this software and associated documentation files (the "Software"), to deal
  30  * in the Software without restriction, including without limitation the rights
  31  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  32  * copies of the Software, and to permit persons to whom the Software is
  33  * furnished to do so, subject to the following conditions:
  34  *
  35  * The above copyright notice and this permission notice shall be included in
  36  * all copies or substantial portions of the Software.
  37  *
  38  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  39  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  40  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  41  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  42  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  43  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  44  * THE SOFTWARE.
  45  */
  46 package com.sun.xml.internal.rngom.ast.builder;
  47 
  48 import com.sun.xml.internal.rngom.ast.om.Location;
  49 import com.sun.xml.internal.rngom.ast.om.ParsedElementAnnotation;
  50 import com.sun.xml.internal.rngom.ast.om.ParsedPattern;
  51 
  52 /**
  53  * The container that can have <define> elements.
  54  * <p>
  55  * {@link Div}, {@link Grammar}, {@link Include}, or {@link IncludedGrammar}.
  56  */
  57 public interface GrammarSection<
  58     P extends ParsedPattern,
  59     E extends ParsedElementAnnotation,
  60     L extends Location,
  61     A extends Annotations<E,L,CL>,
  62     CL extends CommentList<L>> {
  63 
  64     static final class Combine {
  65         private final String name;
  66         private Combine(String name) {
  67             this.name = name;
  68         }
  69         final public String toString() {
  70             return name;
  71         }
  72     }
  73 
  74     static final Combine COMBINE_CHOICE = new Combine("choice");
  75     static final Combine COMBINE_INTERLEAVE = new Combine("interleave");
  76 
  77     // using \u0000 guarantees that the name will be never used as
  78     // a user-defined pattern name.
  79     static final String START = "\u0000#start\u0000";
  80 
  81     /**
  82      * Called when a pattern is defined.
  83      *
  84      * @param name
  85      *      Name of the pattern. For the definition by a &lt;start/> element,
  86      *      this parameter is the same as {@link #START}.
  87      *      to test if it's a named pattern definition or the start pattern definition.
  88      * @param combine
  89      *      null or {@link #COMBINE_CHOICE} or {@link #COMBINE_INTERLEAVE} depending
  90      *      on the value of the combine attribute.
  91      * @param pattern
  92      *      The pattern to be defined.
  93      */
  94     void define( String name, Combine combine, P pattern, L loc, A anno) throws BuildException;
  95 
  96     /**
  97      * Called when an annotation is found.
  98      */
  99     void topLevelAnnotation(E ea) throws BuildException;
 100 
 101     /**
 102      * Called when a comment is found.
 103      */
 104     void topLevelComment(CL comments) throws BuildException;
 105 
 106     /**
 107      * Called when &lt;div> is found.
 108      *
 109      * @return
 110      *      the returned {@link Div} object will receive callbacks for structures
 111      *      inside the &lt;div> element.
 112      */
 113     Div<P,E,L,A,CL> makeDiv();
 114 
 115     /**
 116      * Returns null if already in an include.
 117      */
 118     Include<P,E,L,A,CL> makeInclude();
 119 }
--- EOF ---