raccoon.core.uitest.data
Class UiTest

java.lang.Object
  raccoon.core.uitest.data.UiTest

public class UiTest
extends java.lang.Object

The configuration elements of a single test.

A single test is a test case scenario where, either the data to send (stimulus) or the data to receive is unitary.
Of, if you prefer:

• The emission of a single data element resulting in one or several data elements being received is a valid UiTest.
• The emission of one or more data elements resulting in one and only one data element being received is a valid UiTest.
• The emission of more than one data element resulting in more than one data element being received is not a valid UiTest.

Since:

Raccoon v0.7

Version:

$Id: UiTest.java,v 1.1 2004/08/08 20:19:18 crouvrais Exp $

Author:

Cedric ROUVRAIS

Field Summary

static long

DEFAULT_TIMEOUT The default time out in milliseconds

Constructor Summary

UiTest()
Default constructor

Method Summary

void	addExpected(ComponentFile pExpected) Adds an expected message to the list of current messages.
void	addIgnore(UiIgnore pIgnore) Adds a new ignore rule to this test.
void	addSubscriber(ComponentFile pSubscriber) Adds a new subscriber to the current test case.
java.util.ArrayList	getExpected() The expected list of messages.
java.util.ArrayList	getIgnore() The list of ignore rules attached to this test instance.
java.lang.String	getName() Retrieves the name of this test.
ComponentFile	getPublisher() The description of the publisher associated to this test case.
java.util.ArrayList	getSubscribers() The collection of subscribers.
long	getTimeOut() The timeout value of this test.
void	setExpected(java.util.ArrayList pExpected) Defines the list of expected messages
void	setIgnore(java.util.ArrayList pIgnore) Defines the list of ignore rules assigned to this test.
void	setName(java.lang.String pName) Defines the name of this test case.
void	setPublisher(ComponentFile pPublisher) Defines the publisher for this test case.
void	setSubscribers(java.util.ArrayList pSubscribers) Defines the collection of subscribers to use for this case.
void	setTimeOut(long pTimeOut) Defines the timeout value of this test.
java.lang.String	toString() The name of this uitest instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

The default time out in milliseconds

See Also:

Constant Field Values

Constructor Detail

UiTest

public UiTest()

Default constructor

Method Detail

getName

public java.lang.String getName()

Retrieves the name of this test.

Returns:

the name of this test

setName

public void setName(java.lang.String pName)

Defines the name of this test case.

Parameters:

pName - the name of this test case, unique for a given UiCase

getPublisher

public ComponentFile getPublisher()

The description of the publisher associated to this test case.

Returns:

the publisher for this test case

setPublisher

public void setPublisher(ComponentFile pPublisher)

Defines the publisher for this test case.

Parameters:

pPublisher - the publisher to use.

getSubscribers

public java.util.ArrayList getSubscribers()

The collection of subscribers.

Returns:

the list of ComponentFile

setSubscribers

public void setSubscribers(java.util.ArrayList pSubscribers)

Defines the collection of subscribers to use for this case.

Parameters:

pSubscribers - the subscribers, a list of ComponentFile.

addSubscriber

public void addSubscriber(ComponentFile pSubscriber)

Adds a new subscriber to the current test case.

Parameters:

pSubscriber - the new subscriber.

getTimeOut

public long getTimeOut()

The timeout value of this test.

Returns:

the number of milliseconds before this test times out.

setTimeOut

public void setTimeOut(long pTimeOut)

Defines the timeout value of this test.

Parameters:

pTimeOut - the number of milliseconds before this test should time out.

getExpected

public java.util.ArrayList getExpected()

The expected list of messages.

Returns:

the list of ComponentFile

setExpected

public void setExpected(java.util.ArrayList pExpected)

Defines the list of expected messages

Parameters:

pExpected - the expected messages, a list of ComponentFile.

addExpected

public void addExpected(ComponentFile pExpected)

Adds an expected message to the list of current messages.

Parameters:

pExpected - the expected messsage.

getIgnore

public java.util.ArrayList getIgnore()

The list of ignore rules attached to this test instance.

Returns:

an array list of UiIgnore.

setIgnore

public void setIgnore(java.util.ArrayList pIgnore)

Defines the list of ignore rules assigned to this test.

Parameters:

pIgnore - an array list of UiIgnore.

addIgnore

public void addIgnore(UiIgnore pIgnore)

Adds a new ignore rule to this test.

Parameters:

pIgnore - the ignore rule to add to this test.

toString

public java.lang.String toString()

The name of this uitest instance

Overrides:

toString in class java.lang.Object

Returns:

the name of this instance, see getName()