aos.apib
Class APIString

java.lang.Object
  aos.apib.APIString

All Implemented Interfaces:

Base

public class APIString

extends java.lang.Object

implements Base

APIString is a simple class that implements the Base interface. The purpose of APIString is to encapsulate a single String member. This is useful for when a String needs to be added to an Aggregate list which only accepts objects of type Base. It is a JACOB object defined as:

     <Class :name "APIString"
         :fields (
             <Field :name "val" :type :string >
         )
     >
 

Field Summary

java.lang.String

val The String value escapsulated by the APIString Object.

Constructor Summary

APIString()
Constructs an APIString object with a null String value.

APIString(java.lang.String s)
Constructs an APIString object with the given String value.

Method Summary

StreamerSupport	getStreamer() Returns the StreamerSupport object for this type.
java.lang.String	toString() Returns a String describing this object.

Methods inherited from class java.lang.Object

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

Field Detail

val

public java.lang.String val

The String value escapsulated by the APIString Object.

Constructor Detail

APIString

public APIString()

Constructs an APIString object with a null String value.

APIString

public APIString(java.lang.String s)

Constructs an APIString object with the given String value.

Parameters:

s - The initial value of the String.

Method Detail

getStreamer

public StreamerSupport getStreamer()

Returns the StreamerSupport object for this type.

Specified by:

getStreamer in interface Base

toString

public java.lang.String toString()

Returns a String describing this object.

Returns:

the String description.