satin.aro
Class AROstringDatum

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

public class AROstringDatum
extends AROdatum

An incoming string data element.

Author:

Ed Stauff

Fields inherited from class satin.aro.AROdatum

gotten, name

Constructor Summary

AROstringDatum(java.lang.String name, java.lang.String value)
Creates a string 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.
java.lang.String	getString() Returns the value of a string data element.
java.lang.String	toString() Converts the value of the data element to a string.
static java.lang.String	toString(java.lang.String value) Converts a string to its ARO protocol form.

Methods inherited from class satin.aro.AROdatum

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AROstringDatum

public AROstringDatum(java.lang.String name,
                      java.lang.String value)

Creates a string data element.

Parameters:

name

The name of the data element, or null.

value

The value of the data element.

Method Detail

getString

public java.lang.String getString()

Description copied from class: AROdatum

Returns the value of a string data element. Throws an assertion if the data element is not a string.

Overrides:

getString 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.

toString

public static java.lang.String toString(java.lang.String value)

Converts a string to its ARO protocol form. This form is suitable for inclusion in an ARO protocol message. The string is enclosed in quotes, and special characters are escaped.

Parameters:

value

the string to be converted.

Returns:

the string in ARO protocol form.

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.