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: import com.sun.xml.internal.xsom.visitor.XSTermFunction;
29: import com.sun.xml.internal.xsom.visitor.XSTermVisitor;
30: import com.sun.xml.internal.xsom.visitor.XSTermFunctionWithParam;
31:
32: /**
33: * A component that can be referenced from {@link XSParticle}
34: *
35: * This interface provides a set of type check functions (<code>isXXX</code>),
36: * which are essentially:
37: *
38: * <pre>
39: * boolean isXXX() {
40: * return this instanceof XXX;
41: * }
42: * <pre>
43: *
44: * and a set of cast functions (<code>asXXX</code>), which are
45: * essentially:
46: *
47: * <pre>
48: * XXX asXXX() {
49: * if(isXXX()) return (XXX)this;
50: * else return null;
51: * }
52: * </pre>
53: */
54: public interface XSTerm extends XSComponent {
55: void visit(XSTermVisitor visitor);
56:
57: <T> T apply(XSTermFunction<T> function);
58:
59: <T, P> T apply(XSTermFunctionWithParam<T, P> function, P param);
60:
61: // cast functions
62: boolean isWildcard();
63:
64: boolean isModelGroupDecl();
65:
66: boolean isModelGroup();
67:
68: boolean isElementDecl();
69:
70: XSWildcard asWildcard();
71:
72: XSModelGroupDecl asModelGroupDecl();
73:
74: XSModelGroup asModelGroup();
75:
76: XSElementDecl asElementDecl();
77: }
|