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.nc;
  47 
  48 import com.sun.xml.internal.rngom.ast.om.ParsedNameClass;
  49 
  50 import javax.xml.namespace.QName;
  51 import java.io.Serializable;
  52 import java.util.HashSet;
  53 import java.util.Set;
  54 
  55 /**
  56  * Name class is a set of {@link QName}s.
  57  */
  58 public abstract class NameClass implements ParsedNameClass, Serializable {
  59     static final int SPECIFICITY_NONE = -1;
  60     static final int SPECIFICITY_ANY_NAME = 0;
  61     static final int SPECIFICITY_NS_NAME = 1;
  62     static final int SPECIFICITY_NAME = 2;
  63 
  64     /**
  65      * Returns true if the given {@link QName} is a valid name
  66      * for this QName.
  67      */
  68     public abstract boolean contains(QName name);
  69 
  70     public abstract int containsSpecificity(QName name);
  71 
  72     /**
  73      * Visitor pattern support.
  74      */
  75     public abstract <V> V accept(NameClassVisitor<V> visitor);
  76 
  77     /**
  78      * Returns true if the name class accepts infinite number of
  79      * {@link QName}s.
  80      *
  81      * <p>
  82      * Intuitively, this method returns true if the name class is
  83      * some sort of wildcard.
  84      */
  85     public abstract boolean isOpen();
  86 
  87     /**
  88      * If the name class is closed (IOW !{@link #isOpen()}),
  89      * return the set of names in this name class. Otherwise the behavior
  90      * is undefined.
  91      */
  92     public Set<QName> listNames() {
  93         final Set<QName> names = new HashSet<QName>();
  94         accept(new NameClassWalker() {
  95             @Override
  96             public Void visitName(QName name) {
  97                 names.add(name);
  98                 return null;
  99             }
 100         });
 101         return names;
 102     }
 103 
 104     /**
 105      * Returns true if the intersection between this name class
 106      * and the specified name class is non-empty.
 107      */
 108     public final boolean hasOverlapWith( NameClass nc2 ) {
 109         return OverlapDetector.overlap(this,nc2);
 110     }
 111 
 112 
 113     /** Sigleton instance that represents "anyName". */
 114     public static final NameClass ANY = new AnyNameClass();
 115 
 116     /**
 117      * Sigleton instance that accepts no name.
 118      *
 119      * <p>
 120      * This instance is useful when doing boolean arithmetic over
 121      * name classes (such as computing an inverse of a given name class, etc),
 122      * even though it can never appear in a RELAX NG surface syntax.
 123      *
 124      * <p>
 125      * Internally, this instance is also used for:
 126      * <ol>
 127      *  <li>Used to recover from errors during parsing.
 128      *  <li>Mark element patterns with {@code <notAllowed/>} content model.
 129      * </ol>
 130      */
 131     public static final NameClass NULL = new NullNameClass();
 132 }