1/*
2 * Copyright (c) 1997, 2012, 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
26package com.sun.xml.internal.xsom;
27
28/**
29 * Model group.
30 *
31 * @author
32 *  Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
33 */
34public interface XSModelGroup extends XSComponent, XSTerm, Iterable<XSParticle>
35{
36    /**
37     * Type-safe enumeration for kind of model groups.
38     * Constants are defined in the {@link XSModelGroup} interface.
39     */
40    public static enum Compositor {
41        ALL("all"),CHOICE("choice"),SEQUENCE("sequence");
42
43        private Compositor(String _value) {
44            this.value = _value;
45        }
46
47        private final String value;
48        /**
49         * Returns the human-readable compositor name.
50         *
51         * @return
52         *      Either "all", "sequence", or "choice".
53         */
54        public String toString() {
55            return value;
56        }
57    }
58    /**
59     * A constant that represents "all" compositor.
60     */
61    static final Compositor ALL = Compositor.ALL;
62    /**
63     * A constant that represents "sequence" compositor.
64     */
65    static final Compositor SEQUENCE = Compositor.SEQUENCE;
66    /**
67     * A constant that represents "choice" compositor.
68     */
69    static final Compositor CHOICE = Compositor.CHOICE;
70
71    Compositor getCompositor();
72
73    /**
74     * Gets <i>i</i>-ith child.
75     */
76    XSParticle getChild(int idx);
77    /**
78     * Gets the number of children.
79     */
80    int getSize();
81
82    /**
83     * Gets all the children in one array.
84     */
85    XSParticle[] getChildren();
86}
87