satin.aro
Class AROincomingResponse

java.lang.Object
  |
  +--satin.aro.AROdatum
        |
        +--satin.aro.AROcompoundDatum
              |
              +--satin.aro.AROincomingResponse

public class AROincomingResponse
extends AROcompoundDatum

An incoming response to an ARO request. Each response may either be a normal response or an exception response. Exception response are normally wrapped in an AROexception and thrown.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROcompoundDatum

debug

Fields inherited from class satin.aro.AROdatum

gotten, name

Constructor Summary

AROincomingResponse(java.lang.String input)
Constructs a response from an ARO protocol string.

Method Summary

void	finish() Makes sure that all the data elements have been read.
boolean	isException() Tells whether the response is an exception.
boolean	isFinished() Tells whether finish has been called on this object.

Methods inherited from class satin.aro.AROcompoundDatum

addDatum, addToOutput, dump, exists, findByName, firstChar, getAROtypeName, getBoolean, getBoolean, getCompound, getCompound, getCompound, getCount, getDatum, getInteger, getInteger, getName, getNth, getObjectID, getObjectID, getReal, getReal, getString, getString, parseAssignment, parseDatum, parseName, removeAll, toString, trimLeadingSpaces

Methods inherited from class satin.aro.AROdatum

addToOutput, dump, getBoolean, getInteger, getName, getObjectID, getReal, getString, wasGotten

Methods inherited from class java.lang.Object

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

Constructor Detail

AROincomingResponse

public AROincomingResponse(java.lang.String input)

Constructs a response from an ARO protocol string.

Parameters:

input

an ARO protocol string containing a response.

Method Detail

isException

public boolean isException()

Tells whether the response is an exception.

Returns:

true if the response is an exception, otherwise false.

finish

public void finish()

Makes sure that all the data elements have been read. This is used in client-side wrapper methods to check for extraneous data in a response. Throws an exception if the response contains any data elements whose value has not been gotten at least once, as reported by the wasGotten method.

isFinished

public boolean isFinished()

Tells whether finish has been called on this object.

Revision History

4/6/01 Ed Stauff - changes per initial code review.