/*

 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.xsom;

/**

 * Model group.

 *

 * @author

 *  Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

 */

public interface XSModelGroup extends XSComponent, XSTerm, Iterable<XSParticle>

{

    /**

     * Type-safe enumeration for kind of model groups.

     * Constants are defined in the {@link XSModelGroup} interface.

     */

    public static enum Compositor {

        ALL("all"),CHOICE("choice"),SEQUENCE("sequence");

        private Compositor(String _value) {

            this.value = _value;

        }

        private final String value;

        /**

         * Returns the human-readable compositor name.

         *

         * @return

         *      Either "all", "sequence", or "choice".

         */

        public String toString() {

            return value;

        }

    }

    /**

     * A constant that represents "all" compositor.

     */

    static final Compositor ALL = Compositor.ALL;

    /**

     * A constant that represents "sequence" compositor.

     */

    static final Compositor SEQUENCE = Compositor.SEQUENCE;

    /**

     * A constant that represents "choice" compositor.

     */

    static final Compositor CHOICE = Compositor.CHOICE;

    Compositor getCompositor();

    /**

     * Gets <i>i</i>-ith child.

     */

    XSParticle getChild(int idx);

    /**

     * Gets the number of children.

     */

    int getSize();

    /**

     * Gets all the children in one array.

     */

    XSParticle[] getChildren();

}