org.springframework.statemachine.state.EnumState.java Source code

Introduction

Here is the source code for org.springframework.statemachine.state.EnumState.java

Source

/*
 * Copyright 2015-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.statemachine.state;

import java.util.Collection;
import java.util.function.Function;

import org.springframework.statemachine.StateContext;
import org.springframework.statemachine.StateMachine;
import org.springframework.statemachine.region.Region;

import reactor.core.publisher.Mono;

/**
 * A {@link State} implementation where state and event is enum based.
 *
 * @author Janne Valkealahti
 *
 * @param <S> the type of state
 * @param <E> the type of event
 */
public class EnumState<S extends Enum<S>, E extends Enum<E>> extends ObjectState<S, E> {

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     */
    public EnumState(S id) {
        super(id);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param pseudoState the pseudo state
     */
    public EnumState(S id, PseudoState<S, E> pseudoState) {
        super(id, pseudoState);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param deferred the deferred
     */
    public EnumState(S id, Collection<E> deferred) {
        super(id, deferred);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param deferred the deferred
     * @param entryActions the entry actions
     * @param exitActions the exit actions
     */
    public EnumState(S id, Collection<E> deferred,
            Collection<Function<StateContext<S, E>, Mono<Void>>> entryActions,
            Collection<Function<StateContext<S, E>, Mono<Void>>> exitActions) {
        super(id, deferred, entryActions, exitActions);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param deferred the deferred
     * @param entryActions the entry actions
     * @param exitActions the exit actions
     * @param pseudoState the pseudo state
     */
    public EnumState(S id, Collection<E> deferred,
            Collection<Function<StateContext<S, E>, Mono<Void>>> entryActions,
            Collection<Function<StateContext<S, E>, Mono<Void>>> exitActions, PseudoState<S, E> pseudoState) {
        super(id, deferred, entryActions, exitActions, pseudoState);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param deferred the deferred
     * @param entryActions the entry actions
     * @param exitActions the exit actions
     * @param pseudoState the pseudo state
     * @param regions the regions
     */
    public EnumState(S id, Collection<E> deferred,
            Collection<Function<StateContext<S, E>, Mono<Void>>> entryActions,
            Collection<Function<StateContext<S, E>, Mono<Void>>> exitActions, PseudoState<S, E> pseudoState,
            Collection<Region<S, E>> regions) {
        super(id, deferred, entryActions, exitActions, pseudoState, regions);
    }

    /**
     * Instantiates a new enum state.
     *
     * @param id the id
     * @param deferred the deferred
     * @param entryActions the entry actions
     * @param exitActions the exit actions
     * @param pseudoState the pseudo state
     * @param submachine the submachine
     */
    public EnumState(S id, Collection<E> deferred,
            Collection<Function<StateContext<S, E>, Mono<Void>>> entryActions,
            Collection<Function<StateContext<S, E>, Mono<Void>>> exitActions, PseudoState<S, E> pseudoState,
            StateMachine<S, E> submachine) {
        super(id, deferred, entryActions, exitActions, pseudoState, submachine);
    }

}