ides.api.model.fsa
Interface FSAState

All Superinterfaces:
Annotable, DESElement

public interface FSAState
extends DESElement

The interface defining a representation of a state in a finite state automaton.

Author:
Helen Bretzke

Method Summary
 void addIncomingTransition(FSATransition t)
          Adds a transition that ends in this state.
 void addOutgoingTransition(FSATransition t)
          Adds a transition that originates from this state.
 int getIncomingTransitionsCount()
          Returns the number of transitions ending in this state.
 java.util.ListIterator<FSATransition> getIncomingTransitionsListIterator()
          Returns an iterator for the transitions ending in this state.
 java.lang.String getName()
          Gets the name of the state
 int getOutgoingTransitionsCount()
          Returns the number of transitions originating from this state.
 java.util.ListIterator<FSATransition> getOutgoingTransitionsListIterator()
          Returns an iterator for the transitions originating from this state.
 boolean isInitial()
          Returns true iff this is an initial state.
 boolean isMarked()
          Returns true iff this is a marked (final) state.
 void removeIncomingTransition(FSATransition t)
          Removes a transition that ends in this state.
 void removeOutgoingTransition(FSATransition t)
          Removes a transition that originates from this state.
 void setInitial(boolean b)
          Sets the "initial" property of the state.
 void setMarked(boolean b)
          Sets the "marked" property of the state.
 void setName(java.lang.String name)
          Sets an annotation for the name of the state
 
Methods inherited from interface ides.api.plugin.model.DESElement
getId, setId
 
Methods inherited from interface ides.api.core.Annotable
getAnnotation, hasAnnotation, removeAnnotation, setAnnotation
 

Method Detail

getName

java.lang.String getName()
Gets the name of the state

Returns:
a String countaining the name of the state

setName

void setName(java.lang.String name)
Sets an annotation for the name of the state

Parameters:
name - , the name for the String

addOutgoingTransition

void addOutgoingTransition(FSATransition t)
Adds a transition that originates from this state.

Parameters:
t - the transition to be added

removeOutgoingTransition

void removeOutgoingTransition(FSATransition t)
Removes a transition that originates from this state.

Parameters:
t - the transition to be removed

getOutgoingTransitionsListIterator

java.util.ListIterator<FSATransition> getOutgoingTransitionsListIterator()
Returns an iterator for the transitions originating from this state.

Returns:
a source transition iterator

getOutgoingTransitionsCount

int getOutgoingTransitionsCount()
Returns the number of transitions originating from this state.

Returns:
the number of transitions originating from this state

addIncomingTransition

void addIncomingTransition(FSATransition t)
Adds a transition that ends in this state.

Parameters:
t - the transition to be added.

removeIncomingTransition

void removeIncomingTransition(FSATransition t)
Removes a transition that ends in this state.

Parameters:
t - the transition to be removed.

getIncomingTransitionsListIterator

java.util.ListIterator<FSATransition> getIncomingTransitionsListIterator()
Returns an iterator for the transitions ending in this state.

Returns:
an iterator for the transitions ending in this state

getIncomingTransitionsCount

int getIncomingTransitionsCount()
Returns the number of transitions ending in this state.

Returns:
the number of transitions ending in this state

isInitial

boolean isInitial()
Returns true iff this is an initial state.

Returns:
true iff this is an initial state

isMarked

boolean isMarked()
Returns true iff this is a marked (final) state.

Returns:
true iff this is marked (final) state

setInitial

void setInitial(boolean b)
Sets the "initial" property of the state.

Parameters:
b - true if state to become initial, false otherwise

setMarked

void setMarked(boolean b)
Sets the "marked" property of the state.

Parameters:
b - true if state to become marked, false otherwise