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: /**
aoqi@0:  * Base interface for {@link XSComplexType} and {@link XSSimpleType}.
aoqi@0:  *
aoqi@0:  * @author
aoqi@0:  *  Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
aoqi@0:  */
aoqi@0: public interface XSType extends XSDeclaration {
aoqi@0:     /**
aoqi@0:      * Returns the base type of this type.
aoqi@0:      *
aoqi@0:      * Note that if this type represents <tt>xs:anyType</tt>, this method returns itself.
aoqi@0:      * This is awkward as an API, but it follows the schema specification.
aoqi@0:      *
aoqi@0:      * @return  always non-null.
aoqi@0:      */
aoqi@0:     XSType getBaseType();
aoqi@0: 
aoqi@0:     final static int EXTENSION = 1;
aoqi@0:     final static int RESTRICTION = 2;
aoqi@0:     final static int SUBSTITUTION = 4;
aoqi@0: 
aoqi@0:     int getDerivationMethod();
aoqi@0: 
aoqi@0:     /** Returns true if <code>this instanceof XSSimpleType</code>. */
aoqi@0:     boolean isSimpleType();
aoqi@0:     /** Returns true if <code>this instanceof XSComplexType</code>. */
aoqi@0:     boolean isComplexType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Lists up types that can substitute this type by using xsi:type.
aoqi@0:      * Includes this type itself.
aoqi@0:      * <p>
aoqi@0:      * This method honors the block flag.
aoqi@0:      */
aoqi@0:     XSType[] listSubstitutables();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * If this {@link XSType} is redefined by another type,
aoqi@0:      * return that component.
aoqi@0:      *
aoqi@0:      * @return null
aoqi@0:      *      if this component has not been redefined.
aoqi@0:      */
aoqi@0:     XSType getRedefinedBy();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the number of complex types that redefine this component.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * For example, if A is redefined by B and B is redefined by C,
aoqi@0:      * A.getRedefinedCount()==2, B.getRedefinedCount()==1, and
aoqi@0:      * C.getRedefinedCount()==0.
aoqi@0:      */
aoqi@0:     int getRedefinedCount();
aoqi@0: 
aoqi@0: 
aoqi@0:     /** Casts this object to XSSimpleType if possible, otherwise returns null. */
aoqi@0:     XSSimpleType asSimpleType();
aoqi@0:     /** Casts this object to XSComplexType if possible, otherwise returns null. */
aoqi@0:     XSComplexType asComplexType();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns true if this type is derived from the specified type.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * Note that <tt>t.isDerivedFrom(t)</tt> returns true.
aoqi@0:      */
aoqi@0:     boolean isDerivedFrom( XSType t );
aoqi@0: }