Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

Sct.ObjectManager Interface Reference

Inheritance diagram for Sct.ObjectManager:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Methods for end-users.
Name writeObject (Serializable object) throws IOException
 Write a Serializable object.

Serializable readObject (String uniqueID, String className) throws IOException
 Read a Serializable with uniqueID and className as given.

Serializable readObject (String name) throws IOException
 Read a Serializable using the back-end specific identifier.

Methods for streamer implementors
void writeObject (OStream s, String name, Streamable object, boolean writeClassName) throws IOException
 Write an object to the OStream.

Streamable readObject (IStream s, String name, String className) throws IOException
 Read an object from an IStream.

Streamable readObject (IStream s, String name) throws IOException
 Read an object from an IStream.


Detailed Description

Todo:
Add read/write for arrays of objects?

Definition at line 5 of file ObjectManager.java.


Member Function Documentation

Streamable Sct.ObjectManager.readObject IStream  s,
String  name
throws IOException
 

Read an object from an IStream.

This method should be used if the object was written with writeClassName = true. First reads the className from the stream. Creates the object from the IStream

See also:
Streamable documentation
Parameters:
s the IStream being read from in the current context.
name the name of the object in the current context. Should match the name passed to writeObject.
Exceptions:
IOException if a problem occurs during IO

Implemented in Sct.AbstractObjectManager.

Streamable Sct.ObjectManager.readObject IStream  s,
String  name,
String  className
throws IOException
 

Read an object from an IStream.

This method should be used if the object was written with writeClassName = false. Creates the object from the IStream

See also:
Streamable documentation
Parameters:
s the IStream being read from in the current context.
name the name of the object in the current context. Should match the name passed to writeObject.
className the name of a class capable of streaming in the object.
Exceptions:
IOException if a problem occurs during IO

Implemented in Sct.AbstractObjectManager.

Serializable Sct.ObjectManager.readObject String  name  )  throws IOException
 

Read a Serializable using the back-end specific identifier.

Exceptions:
IOException if a problem occurs during IO

Implemented in Sct.File.ObjectManagerFile.

Serializable Sct.ObjectManager.readObject String  uniqueID,
String  className
throws IOException
 

Read a Serializable with uniqueID and className as given.

Exceptions:
IOException if a problem occurs during IO

Implemented in Sct.File.ObjectManagerFile.

void Sct.ObjectManager.writeObject OStream  s,
String  name,
Streamable  object,
boolean  writeClassName
throws IOException
 

Write an object to the OStream.

Class object's write method. object may not be null. Causes a WriteAbortedException if it is.

Parameters:
s the OStream being used (note, not guranteed to be passed to object's write method)
name the name of the object in the current context.
writeClassName if true the className will be written.
Exceptions:
IllegalArgumentException if object is null
IOException if a problem occurs during IO

Implemented in Sct.AbstractObjectManager.

Name Sct.ObjectManager.writeObject Serializable  object  )  throws IOException
 

Write a Serializable object.

Todo:
Should this take an extra back-end dependant parameter?
Returns:
a Name object that can be used to read the written object
Exceptions:
IOException if a problem occurs during IO

Implemented in Sct.File.ObjectManagerFile.


The documentation for this interface was generated from the following file:
Generated on Thu Jul 15 09:56:35 2004 for SCT DAQ/DCS Software - Java by doxygen 1.3.5