Package com.tameif.tame

Class TAMEResponseReader

java.lang.Object

com.tameif.tame.TAMEResponseReader

public abstract class TAMEResponseReader
extends java.lang.Object

A response reader class that iterates through the cues in the response and does stuff to specific responses. This is meant to be a helper class for quick debugging or standard handling.

Author:

Matthew Tropiano

Constructor Summary

Constructors

Constructor and Description
TAMEResponseReader(TAMEResponse response) TAME response reader.

Method Summary

Modifier and Type	Method and Description
abstract boolean	handleCue(Cue cue) Handles a cue.
protected void	handleStop() Called when the reader stops reading cues.
boolean	hasMoreCues() Gets if this has more cues to read from the response.
boolean	read() Reads the response cues, caliing the handleCue(Cue) method for each cue in the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

TAMEResponseReader

public TAMEResponseReader(TAMEResponse response)

TAME response reader.

Parameters:

response - the response that will be read by this.

Method Detail

handleCue

public abstract boolean handleCue(Cue cue)

Handles a cue.

Parameters:

cue - the cue to handle.

Returns:

true if reading should continue, false to halt it.

handleStop

protected void handleStop()

Called when the reader stops reading cues.

hasMoreCues

public final boolean hasMoreCues()

Gets if this has more cues to read from the response.

Returns:

true if so, false if not.

read

public boolean read()

Reads the response cues, caliing the handleCue(Cue) method for each cue in the response. This stops when handleCue(Cue) returns false, or when there are no more cues to read. After this stops reading for whatever reason, this calls handleStop().

Returns:

true if there's more to read and this should be called again, false if not.