satin.aro
Class AROobjectDatum

java.lang.Object
  |
  +--satin.aro.AROdatum
        |
        +--satin.aro.AROobjectDatum

public class AROobjectDatum
extends AROdatum

An incoming ARO object data element.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROdatum

gotten, name

Constructor Summary

AROobjectDatum(java.lang.String name, AROobjectID value)
Creates an object data element.

AROobjectDatum(java.lang.String name, java.lang.StringBuffer input)
Creates an object data element.

Method Summary

void	addToOutput(AROoutgoingData d, java.lang.String name) Copies the incoming data (this object) into the given outgoing data.
void	dump(java.lang.String indent) Dumps the contents of the object for debugging.
AROobjectID	getObjectID() Returns the id of an object data element.
java.lang.String	toString() Converts the value of the data element to a string.

Methods inherited from class satin.aro.AROdatum

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AROobjectDatum

public AROobjectDatum(java.lang.String name,
                      AROobjectID value)

Creates an object data element.

Parameters:

name

The name of the data element, or null.

value

The value of the data element.

AROobjectDatum

public AROobjectDatum(java.lang.String name,
                      java.lang.StringBuffer input)

Creates an object data element. An input string is parsed to get the data element.

Parameters:

name

The name of the data element, or null.

input

(input/output) the input string. Successfully parsed characters are removed from the string buffer.

Method Detail

getObjectID

public AROobjectID getObjectID()

Description copied from class: AROdatum

Returns the id of an object data element. Throws an assertion if the data element is not an ARO object.

Overrides:

getObjectID in class AROdatum

Following copied from class: satin.aro.AROdatum

Returns:

The value of the data element.

addToOutput

public void addToOutput(AROoutgoingData d,
                        java.lang.String name)

Description copied from class: AROdatum

Copies the incoming data (this object) into the given outgoing data.

Overrides:

addToOutput in class AROdatum

Following copied from class: satin.aro.AROdatum

Parameters:

d

the outgoing data

name

the outgoing parameter name, or null for no parameter name.

toString

public java.lang.String toString()

Description copied from class: AROdatum

Converts the value of the data element to a string.

Overrides:

toString in class AROdatum

Following copied from class: satin.aro.AROdatum

Returns:

the value of the data element as a string.

dump

public void dump(java.lang.String indent)

Description copied from class: AROdatum

Dumps the contents of the object for debugging. The output consists of the class name, the datum's name in quotes, a colon, and the datum's value. The output goes to System.out.

Overrides:

dump in class AROdatum

Following copied from class: satin.aro.AROdatum

Parameters:

indent

this string is prepended to each line of output.

Revision History

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

4/5/01 Ed Stauff - made changes per review.

3/27/01 Ed Stauff - initial review.