1 /*
   2  * Copyright (c) 2005, 2010, 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-2015
  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.digested;
  47 
  48 import java.util.HashMap;
  49 import java.util.Iterator;
  50 import java.util.Map;
  51 
  52 /**
  53  * {@code <grammar>} pattern, which is a collection of named patterns.
  54  *
  55  * @author Kohsuke Kawaguchi (kk@kohsuke.org)
  56  */
  57 public class DGrammarPattern extends DPattern implements Iterable<DDefine> {
  58     private final Map<String,DDefine> patterns = new HashMap<String,DDefine>();
  59 
  60     DPattern start;
  61 
  62     /**
  63      * Gets the start pattern.
  64      */
  65     public DPattern getStart() {
  66         return start;
  67     }
  68 
  69     /**
  70      * Gets the named pattern by its name.
  71      *
  72      * @return
  73      *      null if not found.
  74      */
  75     public DDefine get( String name ) {
  76         return patterns.get(name);
  77     }
  78 
  79     DDefine getOrAdd( String name ) {
  80         if(patterns.containsKey(name)) {
  81             return get(name);
  82         } else {
  83             DDefine d = new DDefine(name);
  84             patterns.put(name,d);
  85             return d;
  86         }
  87     }
  88 
  89     /**
  90      * Iterates all the {@link DDefine}s in this grammar.
  91      */
  92     public Iterator<DDefine> iterator() {
  93         return patterns.values().iterator();
  94     }
  95 
  96     public boolean isNullable() {
  97         return start.isNullable();
  98     }
  99 
 100     public <V> V accept( DPatternVisitor<V> visitor ) {
 101         return visitor.onGrammar(this);
 102     }
 103 }