uk.ac.sheffield.vtts.model

Class Sequence

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Sequence

Direct Known Subclasses:

TestSequence

public class Sequence
extends Element

Sequence represents a sequence of events to present to a finite state machine. A Sequence consists of a list of Events, where each Event is a symbolic request/response pair, denoting a particular expected kind of behaviour in a finite state Machine. A collection of Sequences forms a Language. A Sequence is equal to another Sequence if it consists of the same ordered list of Events.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Event>	events The sequence of events.
protected int	path The length of the path to explore from the covered State.
protected java.lang.String	state The name of the State to be covered by this Sequence.

Constructor Summary

Constructors

Constructor and Description
Sequence() Creates an empty sequence.
Sequence(Sequence other) Copies another sequence.

Method Summary

Methods

Modifier and Type	Method and Description
Sequence	addEvent(Event event) Adds an event to the end of this sequence.
Sequence	addSequence(Sequence other) Concatenates another sequence onto the end of this sequence.
boolean	equals(java.lang.Object other) Reports whether this sequence is equal to another object.
java.util.List<Event>	getEvents() Returns the ordered list of events.
Event	getFirstEvent() Returns the first event in this Sequence.
Event	getLastEvent() Returns the last event in this Sequence.
int	getPath() Returns the length of the path explored from the covered State.
java.lang.String	getState() Returns the name of the state covered by this Sequence.
int	hashCode() Returns a quasi-unique hash code for this sequence.
boolean	isEmpty() Reports whether this is the empty Sequence.
Sequence	setPath(int path) Sets the length of the path explored from the covered State.
Sequence	setState(java.lang.String state) Sets the name of the state covered by this Sequence.
int	size() Returns the size of this sequence.

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

events

protected java.util.List<Event> events

The sequence of events.

state

protected java.lang.String state

The name of the State to be covered by this Sequence.

path

protected int path

The length of the path to explore from the covered State.

Constructor Detail

Sequence

public Sequence()

Creates an empty sequence.

Sequence

public Sequence(Sequence other)

Copies another sequence. The new sequence is a shallow copy of the old sequence, sharing all of its events. This constructor is used when extending a Sequence to create longer Sequences.

Parameters:

other - the other sequence.

Method Detail

equals

public boolean equals(java.lang.Object other)

Reports whether this sequence is equal to another object. True, if the other object is a sequence consisting of the same events ordered in the same sequence.

Overrides:

equals in class java.lang.Object

Parameters:

other - the other object.

Returns:

true, if both objects are sequences with the same events.

hashCode

public int hashCode()

Returns a quasi-unique hash code for this sequence. Returns the hash code associated with this sequence's list of events.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this sequence.

size

public int size()

Returns the size of this sequence.

Returns:

the length of this sequence.

isEmpty

public boolean isEmpty()

Reports whether this is the empty Sequence.

Returns:

true, if this Sequence is empty.

addEvent

public Sequence addEvent(Event event)

Adds an event to the end of this sequence. Modifies this sequence by adding an event to the end of this sequence's list of events.

Parameters:

event - a named event.

Returns:

this sequence.

addSequence

public Sequence addSequence(Sequence other)

Concatenates another sequence onto the end of this sequence. Modifies this sequence by concatenating all the events from the other sequence, in order, onto the end of this sequence's list of events. The result is a longer sequence which contains this sequence as a prefix and the other sequence as a suffix. The other sequence is unchanged.

Parameters:

other - the other sequence.

Returns:

this sequence.

getEvents

public java.util.List<Event> getEvents()

Returns the ordered list of events.

Returns:

the list of Events.

getFirstEvent

public Event getFirstEvent()

Returns the first event in this Sequence. If this Sequence is empty, returns null, otherwise returns the first Event.

Returns:

the last Event, or null.

getLastEvent

public Event getLastEvent()

Returns the last event in this Sequence. If this Sequence is empty, returns null, otherwise returns the last Event.

Returns:

the last Event, or null.

getState

public java.lang.String getState()

Returns the name of the state covered by this Sequence.

Returns:

the name of the state covered by this Sequence.

setState

public Sequence setState(java.lang.String state)

Sets the name of the state covered by this Sequence.

Parameters:

state - the name of the State to set.

Returns:

this Sequence.

getPath

public int getPath()

Returns the length of the path explored from the covered State.

Returns:

the length of the path explored from the covered State.

setPath

public Sequence setPath(int path)

Sets the length of the path explored from the covered State.

Parameters:

path - the path length to set.

Returns:

this Sequence.