/*
Below is the copyright agreement for the Ptolemy II system.

Copyright (c) 1995-2014 The Regents of the University of California.
All rights reserved.

Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.

Ptolemy II includes the work of others, to see those copyrights, follow
the copyright link on the splash page or see copyright.htm.
 */
/**
 *
 */
package ptolemy.domains.coroutine.kernel;

/**
 * @author shaver
@version $Id: ControlExitToken.java 70398 2014-10-22 23:44:32Z cxh $
@since Ptolemy II 10.0
 *
 */
public class ControlExitToken extends ControlToken {

    private ControlExitToken() {
        _type = ControlType.Non;
        _location = null;
    }

    public static ControlExitToken ExitToken(String etS) {
        if (etS.contentEquals("terminate")) {
            return Terminate();
        }
        if (etS.contentEquals("suspend")) {
            return Suspend();
        }
        return Exit(new ExitLocation(etS));
    }

    public static ControlExitToken Terminate() {
        ControlExitToken ct = new ControlExitToken();
        ct._setExit(ControlType.Terminate, new ExitLocation("terminate"));
        return ct;
    }

    public static ControlExitToken Suspend() {
        ControlExitToken ct = new ControlExitToken();
        ct._setExit(ControlType.Suspend, new ExitLocation("suspend"));
        return ct;
    }

    public static ControlExitToken Exit(ExitLocation l) {
        ControlExitToken ct = new ControlExitToken();
        ct._setExit(ControlType.Exit, l);
        return ct;
    }

    public enum ControlType {
        Non, Terminate, Suspend, Exit
    };

    @Override
    public boolean isEntry() {
        return false;
    }

    @Override
    public boolean isExit() {
        return true;
    }

    public boolean isSuspend() {
        return _type == ControlType.Suspend;
    }

    public boolean isTerminate() {
        return _type == ControlType.Terminate;
    }

    public boolean isLocation() {
        return _type == ControlType.Exit;
    }

    public ControlExitToken.ExitLocation getLocation() {
        return _location;
    }

    public static class ExitLocation implements Location {
        public ExitLocation(String name) {
            this.name = name;
        }

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

        public String name;

        /* (non-Javadoc)
         * @see java.lang.Object#hashCode()
         */
        @Override
        public int hashCode() {
            final int prime = 31;
            int result = 1;
            result = prime * result + (name == null ? 0 : name.hashCode());
            return result;
        }

        /* (non-Javadoc)
         * @see java.lang.Object#equals(java.lang.Object)
         */
        @Override
        public boolean equals(Object obj) {
            if (this == obj) {
                return true;
            }
            if (obj == null) {
                return false;
            }
            if (getClass() != obj.getClass()) {
                return false;
            }
            ExitLocation other = (ExitLocation) obj;
            if (name == null) {
                if (other.name != null) {
                    return false;
                }
            } else if (!name.equals(other.name)) {
                return false;
            }
            return true;
        }

    }

    ////

    @Override
    public String toString() {
        String str = "Non";
        /**/if (_type == ControlType.Terminate) {
            str = "Terminate";
        } else if (_type == ControlType.Suspend) {
            str = "Suspend";
        } else if (_type == ControlType.Exit) {
            str = "Exit[";
            str += _location.toString();
            str += "]";
        }
        return str;
    }

    ////

    private void _setExit(ControlType t, ExitLocation l) {
        _type = t;
        _location = l;
    }

    private ControlType _type;
    private ExitLocation _location;

}