1 /*
2  * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * 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 {
visit( XSTermVisitor visitor )56     void visit( XSTermVisitor visitor );
apply( XSTermFunction<T> function )57     <T> T apply( XSTermFunction<T> function );
apply( XSTermFunctionWithParam<T,P> function, P param )58     <T,P> T apply( XSTermFunctionWithParam<T,P> function, P param );
59 
60     // cast functions
isWildcard()61     boolean isWildcard();
isModelGroupDecl()62     boolean isModelGroupDecl();
isModelGroup()63     boolean isModelGroup();
isElementDecl()64     boolean isElementDecl();
65 
asWildcard()66     XSWildcard asWildcard();
asModelGroupDecl()67     XSModelGroupDecl asModelGroupDecl();
asModelGroup()68     XSModelGroup asModelGroup();
asElementDecl()69     XSElementDecl asElementDecl();
70 }
71