scorej
Class SignalWait

java.lang.Object
  |
  +--scorej.SignalWait

Direct Known Subclasses:

SignalWaitQueue

public class SignalWait

extends java.lang.Object

SignalWait is an internal Scorej class that contains information about a type of Signal that a ScoreJ Thread is waiting for. A SignalWait can contain different tests to match incoming Signals against. SignalWaits are created by the waitForSignal calls in (@link scorej.S) and are managed by the (@link scorej.SignalProcessor).

There are five different "tests" that can be specified.

• Receiver: ID to match against any receiver of the incoming Signal Uses the .equals method to match
• Sender: ID to match against the sender of the Signal Uses the .equals method to match
• Subject: String array to match against the subject of the signal Uses SignalWait's subjectMatch to match The incoming signal's subject array is compared against the SignalWait's subject array. If the incoming signal has longer length array, the extra elements are ignored. Each string element is compared with .equals. A null element in the SignalWait's array is treated as a wild card. eg: Signal ["a", "b", "c"] matches SignalWait [null, "b"], but does not match SignalWait ["b", "c"]
• Pattern: Object array to match against the object args of the signal Uses SignalWait's patternMatch to match, which works just like subjectMatch.
• SignalEvaluator: (@link scorej.SignalEvaluator)
When a matching signal is found by the SignalProcessor, the _matchedSignal field will be set to the matching Signal object. Also, once a Signal is matched, it becomes immutable.

See Also:

Signal, SignalProcessor, SignalEvaluator

Field Summary

protected java.lang.Object[]	_pattern
protected ID	_receiver
protected ID	_sender
protected SignalEvaluator	_signalEvaluator
protected java.lang.String[]	_subject
protected java.lang.Thread	_thread

Method Summary

Signal	getMatchedSignal() Getter for the matchedSignal field
java.lang.Object[]	getPattern()
ID	getReceiver()
ID	getSender()
java.lang.String[]	getSubject()
boolean	matches(Signal signal) Matching method.
boolean	matchSignal(Signal signal) Notify the thread waiting using this SignalWait that the signal arrived.
void	setMatchedSignal(Signal signal)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_receiver

protected ID _receiver

_sender

protected ID _sender

_subject

protected java.lang.String[] _subject

_pattern

protected java.lang.Object[] _pattern

_signalEvaluator

protected SignalEvaluator _signalEvaluator

_thread

protected java.lang.Thread _thread

Method Detail

getPattern

public java.lang.Object[] getPattern()

getReceiver

public ID getReceiver()

getSender

public ID getSender()

getSubject

public java.lang.String[] getSubject()

getMatchedSignal

public Signal getMatchedSignal()

Getter for the matchedSignal field

Returns:

Signal the Signal object that matched with this SignalWait. returns null if no matching Signal has been found yet.

setMatchedSignal

public void setMatchedSignal(Signal signal)

matchSignal

public boolean matchSignal(Signal signal)

Notify the thread waiting using this SignalWait that the signal arrived. This is called by SignalProcessor.java

matches

public boolean matches(Signal signal)

Matching method. Takes a Signal as a parameter and performs each of the five tests. In order to match a Signal must pass all five tests. Any test that is null is automatically passed. The five tests are sender, receiver, subject, pattern, and SignalEvaluator.

Parameters:

signal - the Signal to test

Returns:

true if the Signal passes, false if not.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object