org.restcomm.connect.commons.fsm.State Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restcomm-connect.commons Show documentation
The newest version!
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2014, Telestax Inc and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 *
 */
package org.restcomm.connect.commons.fsm;

import static com.google.common.base.Preconditions.*;

import org.restcomm.connect.commons.annotations.concurrency.Immutable;

/**
 * @author [email protected] (Thomas Quintana)
 */
@Immutable
public class State {
    private final Action actionOnEnter;
    private final Action actionOnState;
    private final Action actionOnExit;
    private final String id;

    public State(final String id, final Action actionOnEnter, final Action actionOnState, final Action actionOnExit) {
        super();
        checkNotNull(id, "A state can not have a null value for id.");
        this.actionOnEnter = actionOnEnter;
        this.actionOnState = actionOnState;
        this.actionOnExit = actionOnExit;
        this.id = id;
    }

    public State(final String id, final Action actionOnEnter, final Action actionOnExit) {
        this(id, actionOnEnter, null, actionOnExit);
    }

    public State(final String id, final Action actionOnState) {
        this(id, null, actionOnState, null);
    }

    @Override
    public boolean equals(final Object object) {
        if (object == null) {
            return false;
        } else if (this == object) {
            return true;
        } else if (getClass() != object.getClass()) {
            return false;
        }
        final State state = (State) object;
        if (!id.equals(state.getId())) {
            return false;
        }
        return true;
    }

    public Action getActionOnEnter() {
        return actionOnEnter;
    }

    public Action getActionOnState() {
        return actionOnState;
    }

    public Action getActionOnExit() {
        return actionOnExit;
    }

    public String getId() {
        return id;
    }

    @Override
    public int hashCode() {
        final int prime = 5;
        int result = 1;
        result = prime * result + id.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return id;
    }
}