01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.xml.internal.xsom;
27:
28: /**
29: * Base interface for {@link XSComplexType} and {@link XSSimpleType}.
30: *
31: * @author
32: * Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
33: */
34: public interface XSType extends XSDeclaration {
35: /**
36: * Returns the base type of this type.
37: *
38: * Note that if this type represents <tt>xs:anyType</tt>, this method returns itself.
39: * This is awkward as an API, but it follows the schema specification.
40: *
41: * @return always non-null.
42: */
43: XSType getBaseType();
44:
45: final static int EXTENSION = 1;
46: final static int RESTRICTION = 2;
47: final static int SUBSTITUTION = 4;
48:
49: int getDerivationMethod();
50:
51: /** Returns true if <code>this instanceof XSSimpleType</code>. */
52: boolean isSimpleType();
53:
54: /** Returns true if <code>this instanceof XSComplexType</code>. */
55: boolean isComplexType();
56:
57: /**
58: * Lists up types that can substitute this type by using xsi:type.
59: * Includes this type itself.
60: * <p>
61: * This method honors the block flag.
62: */
63: XSType[] listSubstitutables();
64:
65: /**
66: * If this {@link XSType} is redefined by another type,
67: * return that component.
68: *
69: * @return null
70: * if this component has not been redefined.
71: */
72: XSType getRedefinedBy();
73:
74: /**
75: * Returns the number of complex types that redefine this component.
76: *
77: * <p>
78: * For example, if A is redefined by B and B is redefined by C,
79: * A.getRedefinedCount()==2, B.getRedefinedCount()==1, and
80: * C.getRedefinedCount()==0.
81: */
82: int getRedefinedCount();
83:
84: /** Casts this object to XSSimpleType if possible, otherwise returns null. */
85: XSSimpleType asSimpleType();
86:
87: /** Casts this object to XSComplexType if possible, otherwise returns null. */
88: XSComplexType asComplexType();
89:
90: /**
91: * Returns true if this type is derived from the specified type.
92: *
93: * <p>
94: * Note that <tt>t.isDerivedFrom(t)</tt> returns true.
95: */
96: boolean isDerivedFrom(XSType t);
97: }
|