aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: /*
aoqi@0:  * Copyright (C) 2004-2011
aoqi@0:  *
aoqi@0:  * Permission is hereby granted, free of charge, to any person obtaining a copy
aoqi@0:  * of this software and associated documentation files (the "Software"), to deal
aoqi@0:  * in the Software without restriction, including without limitation the rights
aoqi@0:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
aoqi@0:  * copies of the Software, and to permit persons to whom the Software is
aoqi@0:  * furnished to do so, subject to the following conditions:
aoqi@0:  *
aoqi@0:  * The above copyright notice and this permission notice shall be included in
aoqi@0:  * all copies or substantial portions of the Software.
aoqi@0:  *
aoqi@0:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
aoqi@0:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
aoqi@0:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
aoqi@0:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
aoqi@0:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
aoqi@0:  * THE SOFTWARE.
aoqi@0:  */
aoqi@0: package com.sun.xml.internal.rngom.nc;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.rngom.ast.om.ParsedNameClass;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: import java.io.Serializable;
aoqi@0: import java.util.HashSet;
aoqi@0: import java.util.Set;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Name class is a set of {@link QName}s.
aoqi@0:  */
aoqi@0: public abstract class NameClass implements ParsedNameClass, Serializable {
aoqi@0:     static final int SPECIFICITY_NONE = -1;
aoqi@0:     static final int SPECIFICITY_ANY_NAME = 0;
aoqi@0:     static final int SPECIFICITY_NS_NAME = 1;
aoqi@0:     static final int SPECIFICITY_NAME = 2;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if the given {@link QName} is a valid name
aoqi@0:      * for this QName.
aoqi@0:      */
aoqi@0:     public abstract boolean contains(QName name);
aoqi@0: 
aoqi@0:     public abstract int containsSpecificity(QName name);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Visitor pattern support.
aoqi@0:      */
aoqi@0:     public abstract <V> V accept(NameClassVisitor<V> visitor);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if the name class accepts infinite number of
aoqi@0:      * {@link QName}s.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * Intuitively, this method returns true if the name class is
aoqi@0:      * some sort of wildcard.
aoqi@0:      */
aoqi@0:     public abstract boolean isOpen();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * If the name class is closed (IOW !{@link #isOpen()}),
aoqi@0:      * return the set of names in this name class. Otherwise the behavior
aoqi@0:      * is undefined.
aoqi@0:      */
aoqi@0:     public Set<QName> listNames() {
aoqi@0:         final Set<QName> names = new HashSet<QName>();
aoqi@0:         accept(new NameClassWalker() {
aoqi@0:             @Override
aoqi@0:             public Void visitName(QName name) {
aoqi@0:                 names.add(name);
aoqi@0:                 return null;
aoqi@0:             }
aoqi@0:         });
aoqi@0:         return names;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if the intersection between this name class
aoqi@0:      * and the specified name class is non-empty.
aoqi@0:      */
aoqi@0:     public final boolean hasOverlapWith( NameClass nc2 ) {
aoqi@0:         return OverlapDetector.overlap(this,nc2);
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     /** Sigleton instance that represents "anyName". */
aoqi@0:     public static final NameClass ANY = new AnyNameClass();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Sigleton instance that accepts no name.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This instance is useful when doing boolean arithmetic over
aoqi@0:      * name classes (such as computing an inverse of a given name class, etc),
aoqi@0:      * even though it can never appear in a RELAX NG surface syntax.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * Internally, this instance is also used for:
aoqi@0:      * <ol>
aoqi@0:      *  <li>Used to recover from errors during parsing.
aoqi@0:      *  <li>Mark element patterns with &lt;notAllowed/> content model.
aoqi@0:      * </ol>
aoqi@0:      */
aoqi@0:     public static final NameClass NULL = new NullNameClass();
aoqi@0: }