org.nuiton.eugene.models.state.StateModelComplexState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eugene Show documentation

Efficient Universal Generator.

There is a newer version: 3.0-alpha-15

/*
 * #%L
 * EUGene :: EUGene
 * %%
 * Copyright (C) 2004 - 2010 CodeLutin
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */

package org.nuiton.eugene.models.state;

import java.util.Collection;

/**
 * StateModelComplexeState
 *
 * Represents a complex state that can be composed with a set of states.
 *
 * @author chatellier
 */
public interface StateModelComplexState extends StateModelState {

    /**
     * Return the states set
     *
     * @return a collection of states
     */
    Collection getStates();

    /**
     * Return the non initial state pointed by the initial state of the state
     * set.
     *
     * Exemple :
     * myComplexeState = (
     * init1 -> state2 -> state3 -> final4
     * )
     *
     * myComplexeState.getInitialState() will return state2.
     *
     * @return a state
     */
    StateModelState getInitialState();
}