1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
|
/*
* @(#)TransitionImpl.java
*
* Copyright (C) 2002-2003 Matt Albrecht
* groboclown@users.sourceforge.net
* http://groboutils.sourceforge.net
*
* Part of the GroboUtils package at:
* http://groboutils.sourceforge.net
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package net.sourceforge.groboutils.mbtf.v1.engine;
import net.sourceforge.groboutils.mbtf.v1.IState;
import net.sourceforge.groboutils.mbtf.v1.IAction;
import net.sourceforge.groboutils.mbtf.v1.IValidate;
import net.sourceforge.groboutils.mbtf.v1.ITransition;
/**
* Nearly-Immutable implementation of ITransition. As an immutable, transitions
* cannot be created if there are cycles in the state machine. Therefore,
* there needs to be a way to post-creation correctly populate the Transition's
* destination state. Thus, the destination state may be set once.
*
* @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
* @version $Date: 2003/02/10 22:52:26 $
* @since June 12, 2002
*/
public class TransitionImpl implements ITransition
{
private String name;
private IState destination;
private IAction action;
private IValidate[] validate;
public TransitionImpl( String name, IState dest, IAction a, IValidate[] v )
{
// allow destination to be null
if (name == null || a == null)
{
throw new IllegalArgumentException("no null args");
}
if (v == null)
{
v = new IValidate[0];
}
else
{
int len = v.length;
IValidate[] vv = new IValidate[ len ];
for (int i = len; --i >= 0;)
{
if (v[i] == null)
{
throw new IllegalArgumentException(
"no nulls allowed in IValidate array");
}
// else
vv[i] = v[i];
}
v = vv;
}
this.name = name;
setDestinationState( dest );
this.action = a;
this.validate = v;
}
/**
* Retrieves the name for the transition. This should be unique for
* state-machine assembly purposes, but it does not have to be.
*
* @return a non-null name for this transition.
*/
public String getName()
{
return this.name;
}
/**
* Returns the next state if the corresponding action is executed.
*
* @return destination state, which can never be <tt>null</tt>.
*/
public IState getDestinationState()
{
if (isDestinationStateSet())
{
return this.destination;
}
// else
throw new IllegalStateException("Destination was never set.");
}
/**
* Returns the action used to transition to the destination state.
*
* @return transition's action, which can never be <tt>null</tt>.
*/
public IAction getAction()
{
return this.action;
}
/**
* Returns all validation methods used to assert that the system can
* perform this transition.
*
* @return a list of associated validation instances.
*/
public IValidate[] getValidates()
{
int len = this.validate.length;
IValidate v[] = new IValidate[ len ];
System.arraycopy( this.validate, 0, v, 0, len );
return v;
}
//-------------------------------------------------------------------------
/**
* Allows for post-creation setting of the destination. The destination
* may only be set to a non-<tt>null</tt> value once. If there is an
* attempt to pull the destination through <tt>getDestinationState()</tt>
* and it has not been set yet, then an IllegalStateException will
* be thrown.
*/
public void setDestinationState( IState dest )
{
if (isDestinationStateSet())
{
throw new IllegalStateException(
"Destination has already been set.");
}
else
{
this.destination = dest;
}
}
/**
* Allows for a builder system to detect if the destination state has
* been set or not, without causing the IllegalStateException through
* the <tt>getDestinationState()</tt>.
*/
public boolean isDestinationStateSet()
{
return (this.destination != null);
}
public String toString()
{
return "[Transition "+getName()+"]";
}
}
|