aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 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: package com.sun.xml.internal.xsom;
aoqi@0: 
aoqi@0: import java.util.Iterator;
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.xsom.visitor.XSWildcardFunction;
aoqi@0: import com.sun.xml.internal.xsom.visitor.XSWildcardVisitor;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Wildcard schema component (used for both attribute wildcard
aoqi@0:  * and element wildcard.)
aoqi@0:  *
aoqi@0:  * XSWildcard interface can always be downcasted to either
aoqi@0:  * Any, Other, or Union.
aoqi@0:  */
aoqi@0: public interface XSWildcard extends XSComponent, XSTerm
aoqi@0: {
aoqi@0:     static final int LAX = 1;
aoqi@0:     static final int STRTICT = 2;
aoqi@0:     static final int SKIP = 3;
aoqi@0:     /**
aoqi@0:      * Gets the processing mode.
aoqi@0:      *
aoqi@0:      * @return
aoqi@0:      *      Either LAX, STRICT, or SKIP.
aoqi@0:      */
aoqi@0:     int getMode();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if the specified namespace URI is valid
aoqi@0:      * wrt this wildcard.
aoqi@0:      *
aoqi@0:      * @param namespaceURI
aoqi@0:      *      Use the empty string to test the default no-namespace.
aoqi@0:      */
aoqi@0:     boolean acceptsNamespace(String namespaceURI);
aoqi@0: 
aoqi@0:     /** Visitor support. */
aoqi@0:     void visit(XSWildcardVisitor visitor);
aoqi@0:     <T> T apply(XSWildcardFunction<T> function);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * <code>##any</code> wildcard.
aoqi@0:      */
aoqi@0:     interface Any extends XSWildcard {
aoqi@0:     }
aoqi@0:     /**
aoqi@0:      * <code>##other</code> wildcard.
aoqi@0:      */
aoqi@0:     interface Other extends XSWildcard {
aoqi@0:         /**
aoqi@0:          * Gets the namespace URI excluded from this wildcard.
aoqi@0:          */
aoqi@0:         String getOtherNamespace();
aoqi@0:     }
aoqi@0:     /**
aoqi@0:      * Wildcard of a set of namespace URIs.
aoqi@0:      */
aoqi@0:     interface Union extends XSWildcard {
aoqi@0:         /**
aoqi@0:          * Short for <code>getNamespaces().iterator()</code>
aoqi@0:          */
aoqi@0:         Iterator<String> iterateNamespaces();
aoqi@0: 
aoqi@0:         /**
aoqi@0:          * Read-only list of namespace URIs.
aoqi@0:          */
aoqi@0:         Collection<String> getNamespaces();
aoqi@0:     }
aoqi@0: }