java.io
Class ObjectOutputStream

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.io.OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream 
      extended by java.io.ObjectOutputStream
All Implemented Interfaces:
Closeable sample code for java.io.Closeable definition code for java.io.Closeable , DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput , Flushable sample code for java.io.Flushable definition code for java.io.Flushable , ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput , ObjectStreamConstants sample code for java.io.ObjectStreamConstants definition code for java.io.ObjectStreamConstants

public class ObjectOutputStream
extends OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
implements ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput , ObjectStreamConstants sample code for java.io.ObjectStreamConstants definition code for java.io.ObjectStreamConstants

An ObjectOutputStream writes primitive data types and graphs of Java objects to an OutputStream. The objects can be read (reconstituted) using an ObjectInputStream. Persistent storage of objects can be accomplished by using a file for the stream. If the stream is a network socket stream, the objects can be reconstituted on another host or in another process.

Only objects that support the java.io.Serializable interface can be written to streams. The class of each serializable object is encoded including the class name and signature of the class, the values of the object's fields and arrays, and the closure of any other objects referenced from the initial objects.

The method writeObject is used to write an object to the stream. Any object, including Strings and arrays, is written with writeObject. Multiple objects or primitives can be written to the stream. The objects must be read back from the corresponding ObjectInputstream with the same types and in the same order as they were written.

Primitive data types can also be written to the stream using the appropriate methods from DataOutput. Strings can also be written using the writeUTF method.

The default serialization mechanism for an object writes the class of the object, the class signature, and the values of all non-transient and non-static fields. References to other objects (except in transient or static fields) cause those objects to be written also. Multiple references to a single object are encoded using a reference sharing mechanism so that graphs of objects can be restored to the same shape as when the original was written.

For example to write an object that can be read by the example in ObjectInputStream:

        FileOutputStream fos = new FileOutputStream("t.tmp");
        ObjectOutputStream oos = new ObjectOutputStream(fos);

        oos.writeInt(12345);
        oos.writeObject("Today");
        oos.writeObject(new Date());

        oos.close();
 

Classes that require special handling during the serialization and deserialization process must implement special methods with these exact signatures:

 private void readObject(java.io.ObjectInputStream stream)
     throws IOException, ClassNotFoundException;
 private void writeObject(java.io.ObjectOutputStream stream)
     throws IOException
 

The writeObject method is responsible for writing the state of the object for its particular class so that the corresponding readObject method can restore it. The method does not need to concern itself with the state belonging to the object's superclasses or subclasses. State is saved by writing the individual fields to the ObjectOutputStream using the writeObject method or by using the methods for primitive data types supported by DataOutput.

Serialization does not write out the fields of any object that does not implement the java.io.Serializable interface. Subclasses of Objects that are not serializable can be serializable. In this case the non-serializable class must have a no-arg constructor to allow its fields to be initialized. In this case it is the responsibility of the subclass to save and restore the state of the non-serializable class. It is frequently the case that the fields of that class are accessible (public, package, or protected) or that there are get and set methods that can be used to restore the state.

Serialization of an object can be prevented by implementing writeObject and readObject methods that throw the NotSerializableException. The exception will be caught by the ObjectOutputStream and abort the serialization process.

Implementing the Externalizable interface allows the object to assume complete control over the contents and format of the object's serialized form. The methods of the Externalizable interface, writeExternal and readExternal, are called to save and restore the objects state. When implemented by a class they can write and read their own state using all of the methods of ObjectOutput and ObjectInput. It is the responsibility of the objects to handle any versioning that occurs.

Enum constants are serialized differently than ordinary serializable or externalizable objects. The serialized form of an enum constant consists solely of its name; field values of the constant are not transmitted. To serialize an enum constant, ObjectOutputStream writes the string returned by the constant's name method. Like other serializable or externalizable objects, enum constants can function as the targets of back references appearing subsequently in the serialization stream. The process by which enum constants are serialized cannot be customized; any class-specific writeObject and writeReplace methods defined by enum types are ignored during serialization. Similarly, any serialPersistentFields or serialVersionUID field declarations are also ignored--all enum types have a fixed serialVersionUID of 0L.

Primitive data, excluding serializable fields and externalizable data, is written to the ObjectOutputStream in block-data records. A block data record is composed of a header and data. The block data header consists of a marker and the number of bytes to follow the header. Consecutive primitive data writes are merged into one block-data record. The blocking factor used for a block-data record will be 1024 bytes. Each block-data record will be filled up to 1024 bytes, or be written whenever there is a termination of block-data mode. Calls to the ObjectOutputStream methods writeObject, defaultWriteObject and writeFields initially terminate any existing block-data record.

Since:
JDK1.1
See Also:
DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput , ObjectInputStream sample code for java.io.ObjectInputStream definition code for java.io.ObjectInputStream , Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Externalizable sample code for java.io.Externalizable definition code for java.io.Externalizable , Object Serialization Specification, Section 2, Object Output Classes

Nested Class Summary
static class ObjectOutputStream.PutField sample code for java.io.ObjectOutputStream.PutField definition code for java.io.ObjectOutputStream.PutField
          Provide programmatic access to the persistent fields to be written to ObjectOutput.
 
Field Summary
 
Fields inherited from interface java.io.ObjectStreamConstants sample code for java.io.ObjectStreamConstants definition code for java.io.ObjectStreamConstants
baseWireHandle sample code for java.io.ObjectStreamConstants.baseWireHandle definition code for java.io.ObjectStreamConstants.baseWireHandle , PROTOCOL_VERSION_1 sample code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1 definition code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1 , PROTOCOL_VERSION_2 sample code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_2 definition code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_2 , SC_BLOCK_DATA sample code for java.io.ObjectStreamConstants.SC_BLOCK_DATA definition code for java.io.ObjectStreamConstants.SC_BLOCK_DATA , SC_ENUM sample code for java.io.ObjectStreamConstants.SC_ENUM definition code for java.io.ObjectStreamConstants.SC_ENUM , SC_EXTERNALIZABLE sample code for java.io.ObjectStreamConstants.SC_EXTERNALIZABLE definition code for java.io.ObjectStreamConstants.SC_EXTERNALIZABLE , SC_SERIALIZABLE sample code for java.io.ObjectStreamConstants.SC_SERIALIZABLE definition code for java.io.ObjectStreamConstants.SC_SERIALIZABLE , SC_WRITE_METHOD sample code for java.io.ObjectStreamConstants.SC_WRITE_METHOD definition code for java.io.ObjectStreamConstants.SC_WRITE_METHOD , STREAM_MAGIC sample code for java.io.ObjectStreamConstants.STREAM_MAGIC definition code for java.io.ObjectStreamConstants.STREAM_MAGIC , STREAM_VERSION sample code for java.io.ObjectStreamConstants.STREAM_VERSION definition code for java.io.ObjectStreamConstants.STREAM_VERSION , SUBCLASS_IMPLEMENTATION_PERMISSION sample code for java.io.ObjectStreamConstants.SUBCLASS_IMPLEMENTATION_PERMISSION definition code for java.io.ObjectStreamConstants.SUBCLASS_IMPLEMENTATION_PERMISSION , SUBSTITUTION_PERMISSION sample code for java.io.ObjectStreamConstants.SUBSTITUTION_PERMISSION definition code for java.io.ObjectStreamConstants.SUBSTITUTION_PERMISSION , TC_ARRAY sample code for java.io.ObjectStreamConstants.TC_ARRAY definition code for java.io.ObjectStreamConstants.TC_ARRAY , TC_BASE sample code for java.io.ObjectStreamConstants.TC_BASE definition code for java.io.ObjectStreamConstants.TC_BASE , TC_BLOCKDATA sample code for java.io.ObjectStreamConstants.TC_BLOCKDATA definition code for java.io.ObjectStreamConstants.TC_BLOCKDATA , TC_BLOCKDATALONG sample code for java.io.ObjectStreamConstants.TC_BLOCKDATALONG definition code for java.io.ObjectStreamConstants.TC_BLOCKDATALONG , TC_CLASS sample code for java.io.ObjectStreamConstants.TC_CLASS definition code for java.io.ObjectStreamConstants.TC_CLASS , TC_CLASSDESC sample code for java.io.ObjectStreamConstants.TC_CLASSDESC definition code for java.io.ObjectStreamConstants.TC_CLASSDESC , TC_ENDBLOCKDATA sample code for java.io.ObjectStreamConstants.TC_ENDBLOCKDATA definition code for java.io.ObjectStreamConstants.TC_ENDBLOCKDATA , TC_ENUM sample code for java.io.ObjectStreamConstants.TC_ENUM definition code for java.io.ObjectStreamConstants.TC_ENUM , TC_EXCEPTION sample code for java.io.ObjectStreamConstants.TC_EXCEPTION definition code for java.io.ObjectStreamConstants.TC_EXCEPTION , TC_LONGSTRING sample code for java.io.ObjectStreamConstants.TC_LONGSTRING definition code for java.io.ObjectStreamConstants.TC_LONGSTRING , TC_MAX sample code for java.io.ObjectStreamConstants.TC_MAX definition code for java.io.ObjectStreamConstants.TC_MAX , TC_NULL sample code for java.io.ObjectStreamConstants.TC_NULL definition code for java.io.ObjectStreamConstants.TC_NULL , TC_OBJECT sample code for java.io.ObjectStreamConstants.TC_OBJECT definition code for java.io.ObjectStreamConstants.TC_OBJECT , TC_PROXYCLASSDESC sample code for java.io.ObjectStreamConstants.TC_PROXYCLASSDESC definition code for java.io.ObjectStreamConstants.TC_PROXYCLASSDESC , TC_REFERENCE sample code for java.io.ObjectStreamConstants.TC_REFERENCE definition code for java.io.ObjectStreamConstants.TC_REFERENCE , TC_RESET sample code for java.io.ObjectStreamConstants.TC_RESET definition code for java.io.ObjectStreamConstants.TC_RESET , TC_STRING sample code for java.io.ObjectStreamConstants.TC_STRING definition code for java.io.ObjectStreamConstants.TC_STRING
 
Constructor Summary
protected ObjectOutputStream sample code for java.io.ObjectOutputStream.ObjectOutputStream() definition code for java.io.ObjectOutputStream.ObjectOutputStream() ()
          Provide a way for subclasses that are completely reimplementing ObjectOutputStream to not have to allocate private data just used by this implementation of ObjectOutputStream.
  ObjectOutputStream sample code for java.io.ObjectOutputStream.ObjectOutputStream(java.io.OutputStream) definition code for java.io.ObjectOutputStream.ObjectOutputStream(java.io.OutputStream) (OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  out)
          Creates an ObjectOutputStream that writes to the specified OutputStream.
 
Method Summary
protected  void annotateClass sample code for java.io.ObjectOutputStream.annotateClass(java.lang.Class) definition code for java.io.ObjectOutputStream.annotateClass(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <?> cl)
          Subclasses may implement this method to allow class data to be stored in the stream.
protected  void annotateProxyClass sample code for java.io.ObjectOutputStream.annotateProxyClass(java.lang.Class) definition code for java.io.ObjectOutputStream.annotateProxyClass(java.lang.Class) (Class sample code for java.lang.Class definition code for java.lang.Class <?> cl)
          Subclasses may implement this method to store custom data in the stream along with descriptors for dynamic proxy classes.
 void close sample code for java.io.ObjectOutputStream.close() definition code for java.io.ObjectOutputStream.close() ()
          Closes the stream.
 void defaultWriteObject sample code for java.io.ObjectOutputStream.defaultWriteObject() definition code for java.io.ObjectOutputStream.defaultWriteObject() ()
          Write the non-static and non-transient fields of the current class to this stream.
protected  void drain sample code for java.io.ObjectOutputStream.drain() definition code for java.io.ObjectOutputStream.drain() ()
          Drain any buffered data in ObjectOutputStream.
protected  boolean enableReplaceObject sample code for java.io.ObjectOutputStream.enableReplaceObject(boolean) definition code for java.io.ObjectOutputStream.enableReplaceObject(boolean) (boolean enable)
          Enable the stream to do replacement of objects in the stream.
 void flush sample code for java.io.ObjectOutputStream.flush() definition code for java.io.ObjectOutputStream.flush() ()
          Flushes the stream.
 ObjectOutputStream.PutField sample code for java.io.ObjectOutputStream.PutField definition code for java.io.ObjectOutputStream.PutField putFields sample code for java.io.ObjectOutputStream.putFields() definition code for java.io.ObjectOutputStream.putFields() ()
          Retrieve the object used to buffer persistent fields to be written to the stream.
protected  Object sample code for java.lang.Object definition code for java.lang.Object replaceObject sample code for java.io.ObjectOutputStream.replaceObject(java.lang.Object) definition code for java.io.ObjectOutputStream.replaceObject(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          This method will allow trusted subclasses of ObjectOutputStream to substitute one object for another during serialization.
 void reset sample code for java.io.ObjectOutputStream.reset() definition code for java.io.ObjectOutputStream.reset() ()
          Reset will disregard the state of any objects already written to the stream.
 void useProtocolVersion sample code for java.io.ObjectOutputStream.useProtocolVersion(int) definition code for java.io.ObjectOutputStream.useProtocolVersion(int) (int version)
          Specify stream protocol version to use when writing the stream.
 void write sample code for java.io.ObjectOutputStream.write(byte[]) definition code for java.io.ObjectOutputStream.write(byte[]) (byte[] buf)
          Writes an array of bytes.
 void write sample code for java.io.ObjectOutputStream.write(byte[], int, int) definition code for java.io.ObjectOutputStream.write(byte[], int, int) (byte[] buf, int off, int len)
          Writes a sub array of bytes.
 void write sample code for java.io.ObjectOutputStream.write(int) definition code for java.io.ObjectOutputStream.write(int) (int val)
          Writes a byte.
 void writeBoolean sample code for java.io.ObjectOutputStream.writeBoolean(boolean) definition code for java.io.ObjectOutputStream.writeBoolean(boolean) (boolean val)
          Writes a boolean.
 void writeByte sample code for java.io.ObjectOutputStream.writeByte(int) definition code for java.io.ObjectOutputStream.writeByte(int) (int val)
          Writes an 8 bit byte.
 void writeBytes sample code for java.io.ObjectOutputStream.writeBytes(java.lang.String) definition code for java.io.ObjectOutputStream.writeBytes(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  str)
          Writes a String as a sequence of bytes.
 void writeChar sample code for java.io.ObjectOutputStream.writeChar(int) definition code for java.io.ObjectOutputStream.writeChar(int) (int val)
          Writes a 16 bit char.
 void writeChars sample code for java.io.ObjectOutputStream.writeChars(java.lang.String) definition code for java.io.ObjectOutputStream.writeChars(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  str)
          Writes a String as a sequence of chars.
protected  void writeClassDescriptor sample code for java.io.ObjectOutputStream.writeClassDescriptor(java.io.ObjectStreamClass) definition code for java.io.ObjectOutputStream.writeClassDescriptor(java.io.ObjectStreamClass) (ObjectStreamClass sample code for java.io.ObjectStreamClass definition code for java.io.ObjectStreamClass  desc)
          Write the specified class descriptor to the ObjectOutputStream.
 void writeDouble sample code for java.io.ObjectOutputStream.writeDouble(double) definition code for java.io.ObjectOutputStream.writeDouble(double) (double val)
          Writes a 64 bit double.
 void writeFields sample code for java.io.ObjectOutputStream.writeFields() definition code for java.io.ObjectOutputStream.writeFields() ()
          Write the buffered fields to the stream.
 void writeFloat sample code for java.io.ObjectOutputStream.writeFloat(float) definition code for java.io.ObjectOutputStream.writeFloat(float) (float val)
          Writes a 32 bit float.
 void writeInt sample code for java.io.ObjectOutputStream.writeInt(int) definition code for java.io.ObjectOutputStream.writeInt(int) (int val)
          Writes a 32 bit int.
 void writeLong sample code for java.io.ObjectOutputStream.writeLong(long) definition code for java.io.ObjectOutputStream.writeLong(long) (long val)
          Writes a 64 bit long.
 void writeObject sample code for java.io.ObjectOutputStream.writeObject(java.lang.Object) definition code for java.io.ObjectOutputStream.writeObject(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Write the specified object to the ObjectOutputStream.
protected  void writeObjectOverride sample code for java.io.ObjectOutputStream.writeObjectOverride(java.lang.Object) definition code for java.io.ObjectOutputStream.writeObjectOverride(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Method used by subclasses to override the default writeObject method.
 void writeShort sample code for java.io.ObjectOutputStream.writeShort(int) definition code for java.io.ObjectOutputStream.writeShort(int) (int val)
          Writes a 16 bit short.
protected  void writeStreamHeader sample code for java.io.ObjectOutputStream.writeStreamHeader() definition code for java.io.ObjectOutputStream.writeStreamHeader() ()
          The writeStreamHeader method is provided so subclasses can append or prepend their own header to the stream.
 void writeUnshared sample code for java.io.ObjectOutputStream.writeUnshared(java.lang.Object) definition code for java.io.ObjectOutputStream.writeUnshared(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Writes an "unshared" object to the ObjectOutputStream.
 void writeUTF sample code for java.io.ObjectOutputStream.writeUTF(java.lang.String) definition code for java.io.ObjectOutputStream.writeUTF(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  str)
          Primitive data write of this String in modified UTF-8 format.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

ObjectOutputStream sample code for java.io.ObjectOutputStream(java.io.OutputStream) definition code for java.io.ObjectOutputStream(java.io.OutputStream)

public ObjectOutputStream(OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  out)
                   throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Creates an ObjectOutputStream that writes to the specified OutputStream. This constructor writes the serialization stream header to the underlying stream; callers may wish to flush the stream immediately to ensure that constructors for receiving ObjectInputStreams will not block when reading the header.

If a security manager is installed, this constructor will check for the "enableSubclassImplementation" SerializablePermission when invoked directly or indirectly by the constructor of a subclass which overrides the ObjectOutputStream.putFields or ObjectOutputStream.writeUnshared methods.

Parameters:
out - output stream to write to
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs while writing stream header
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if untrusted subclass illegally overrides security-sensitive methods
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if out is null
See Also:
ObjectOutputStream() sample code for java.io.ObjectOutputStream.ObjectOutputStream() definition code for java.io.ObjectOutputStream.ObjectOutputStream() , putFields() sample code for java.io.ObjectOutputStream.putFields() definition code for java.io.ObjectOutputStream.putFields() , ObjectInputStream.ObjectInputStream(InputStream) sample code for java.io.ObjectInputStream.ObjectInputStream(java.io.InputStream) definition code for java.io.ObjectInputStream.ObjectInputStream(java.io.InputStream)

ObjectOutputStream sample code for java.io.ObjectOutputStream() definition code for java.io.ObjectOutputStream()

protected ObjectOutputStream()
                      throws IOException sample code for java.io.IOException definition code for java.io.IOException ,
                             SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException 
Provide a way for subclasses that are completely reimplementing ObjectOutputStream to not have to allocate private data just used by this implementation of ObjectOutputStream.

If there is a security manager installed, this method first calls the security manager's checkPermission method with a SerializablePermission("enableSubclassImplementation") permission to ensure it's ok to enable subclassing.

Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and its checkPermission method denies enabling subclassing.
IOException sample code for java.io.IOException definition code for java.io.IOException
See Also:
SecurityManager.checkPermission(java.security.Permission) sample code for java.lang.SecurityManager.checkPermission(java.security.Permission) definition code for java.lang.SecurityManager.checkPermission(java.security.Permission) , SerializablePermission sample code for java.io.SerializablePermission definition code for java.io.SerializablePermission
Method Detail

useProtocolVersion sample code for java.io.ObjectOutputStream.useProtocolVersion(int) definition code for java.io.ObjectOutputStream.useProtocolVersion(int)

public void useProtocolVersion(int version)
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Specify stream protocol version to use when writing the stream.

This routine provides a hook to enable the current version of Serialization to write in a format that is backwards compatible to a previous version of the stream format.

Every effort will be made to avoid introducing additional backwards incompatibilities; however, sometimes there is no other alternative.

Parameters:
version - use ProtocolVersion from java.io.ObjectStreamConstants.
Throws:
IllegalStateException sample code for java.lang.IllegalStateException definition code for java.lang.IllegalStateException - if called after any objects have been serialized.
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if invalid version is passed in.
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur
Since:
1.2
See Also:
ObjectStreamConstants.PROTOCOL_VERSION_1 sample code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1 definition code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1 , ObjectStreamConstants.PROTOCOL_VERSION_2 sample code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_2 definition code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_2

writeObject sample code for java.io.ObjectOutputStream.writeObject(java.lang.Object) definition code for java.io.ObjectOutputStream.writeObject(java.lang.Object)

public final void writeObject(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
                       throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Write the specified object to the ObjectOutputStream. The class of the object, the signature of the class, and the values of the non-transient and non-static fields of the class and all of its supertypes are written. Default serialization for a class can be overridden using the writeObject and the readObject methods. Objects referenced by this object are written transitively so that a complete equivalent graph of objects can be reconstructed by an ObjectInputStream.

Exceptions are thrown for problems with the OutputStream and for classes that should not be serialized. All exceptions are fatal to the OutputStream, which is left in an indeterminate state, and it is up to the caller to ignore or recover the stream state.

Specified by:
writeObject sample code for java.io.ObjectOutput.writeObject(java.lang.Object) definition code for java.io.ObjectOutput.writeObject(java.lang.Object) in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Parameters:
obj - the object to be written
Throws:
InvalidClassException sample code for java.io.InvalidClassException definition code for java.io.InvalidClassException - Something is wrong with a class used by serialization.
NotSerializableException sample code for java.io.NotSerializableException definition code for java.io.NotSerializableException - Some object to be serialized does not implement the java.io.Serializable interface.
IOException sample code for java.io.IOException definition code for java.io.IOException - Any exception thrown by the underlying OutputStream.

writeObjectOverride sample code for java.io.ObjectOutputStream.writeObjectOverride(java.lang.Object) definition code for java.io.ObjectOutputStream.writeObjectOverride(java.lang.Object)

protected void writeObjectOverride(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
                            throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Method used by subclasses to override the default writeObject method. This method is called by trusted subclasses of ObjectInputStream that constructed ObjectInputStream using the protected no-arg constructor. The subclass is expected to provide an override method with the modifier "final".

Parameters:
obj - object to be written to the underlying stream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if there are I/O errors while writing to the underlying stream
Since:
1.2
See Also:
ObjectOutputStream() sample code for java.io.ObjectOutputStream.ObjectOutputStream() definition code for java.io.ObjectOutputStream.ObjectOutputStream() , writeObject(Object) sample code for java.io.ObjectOutputStream.writeObject(java.lang.Object) definition code for java.io.ObjectOutputStream.writeObject(java.lang.Object)

writeUnshared sample code for java.io.ObjectOutputStream.writeUnshared(java.lang.Object) definition code for java.io.ObjectOutputStream.writeUnshared(java.lang.Object)

public void writeUnshared(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
                   throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes an "unshared" object to the ObjectOutputStream. This method is identical to writeObject, except that it always writes the given object as a new, unique object in the stream (as opposed to a back-reference pointing to a previously serialized instance). Specifically: While writing an object via writeUnshared does not in itself guarantee a unique reference to the object when it is deserialized, it allows a single object to be defined multiple times in a stream, so that multiple calls to readUnshared by the receiver will not conflict. Note that the rules described above only apply to the base-level object written with writeUnshared, and not to any transitively referenced sub-objects in the object graph to be serialized.

ObjectOutputStream subclasses which override this method can only be constructed in security contexts possessing the "enableSubclassImplementation" SerializablePermission; any attempt to instantiate such a subclass without this permission will cause a SecurityException to be thrown.

Parameters:
obj - object to write to stream
Throws:
NotSerializableException sample code for java.io.NotSerializableException definition code for java.io.NotSerializableException - if an object in the graph to be serialized does not implement the Serializable interface
InvalidClassException sample code for java.io.InvalidClassException definition code for java.io.InvalidClassException - if a problem exists with the class of an object to be serialized
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs during serialization

defaultWriteObject sample code for java.io.ObjectOutputStream.defaultWriteObject() definition code for java.io.ObjectOutputStream.defaultWriteObject()

public void defaultWriteObject()
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Write the non-static and non-transient fields of the current class to this stream. This may only be called from the writeObject method of the class being serialized. It will throw the NotActiveException if it is called otherwise.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying OutputStream

putFields sample code for java.io.ObjectOutputStream.putFields() definition code for java.io.ObjectOutputStream.putFields()

public ObjectOutputStream.PutField sample code for java.io.ObjectOutputStream.PutField definition code for java.io.ObjectOutputStream.PutField  putFields()
                                      throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Retrieve the object used to buffer persistent fields to be written to the stream. The fields will be written to the stream when writeFields method is called.

Returns:
an instance of the class Putfield that holds the serializable fields
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur
Since:
1.2

writeFields sample code for java.io.ObjectOutputStream.writeFields() definition code for java.io.ObjectOutputStream.writeFields()

public void writeFields()
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Write the buffered fields to the stream.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream
NotActiveException sample code for java.io.NotActiveException definition code for java.io.NotActiveException - Called when a classes writeObject method was not called to write the state of the object.
Since:
1.2

reset sample code for java.io.ObjectOutputStream.reset() definition code for java.io.ObjectOutputStream.reset()

public void reset()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Reset will disregard the state of any objects already written to the stream. The state is reset to be the same as a new ObjectOutputStream. The current point in the stream is marked as reset so the corresponding ObjectInputStream will be reset at the same point. Objects previously written to the stream will not be refered to as already being in the stream. They will be written to the stream again.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if reset() is invoked while serializing an object.

annotateClass sample code for java.io.ObjectOutputStream.annotateClass(java.lang.Class<?>) definition code for java.io.ObjectOutputStream.annotateClass(java.lang.Class<?>)

protected void annotateClass(Class sample code for java.lang.Class definition code for java.lang.Class <?> cl)
                      throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Subclasses may implement this method to allow class data to be stored in the stream. By default this method does nothing. The corresponding method in ObjectInputStream is resolveClass. This method is called exactly once for each unique class in the stream. The class name and signature will have already been written to the stream. This method may make free use of the ObjectOutputStream to save any representation of the class it deems suitable (for example, the bytes of the class file). The resolveClass method in the corresponding subclass of ObjectInputStream must read and use any data or objects written by annotateClass.

Parameters:
cl - the class to annotate custom data for
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - Any exception thrown by the underlying OutputStream.

annotateProxyClass sample code for java.io.ObjectOutputStream.annotateProxyClass(java.lang.Class<?>) definition code for java.io.ObjectOutputStream.annotateProxyClass(java.lang.Class<?>)

protected void annotateProxyClass(Class sample code for java.lang.Class definition code for java.lang.Class <?> cl)
                           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Subclasses may implement this method to store custom data in the stream along with descriptors for dynamic proxy classes.

This method is called exactly once for each unique proxy class descriptor in the stream. The default implementation of this method in ObjectOutputStream does nothing.

The corresponding method in ObjectInputStream is resolveProxyClass. For a given subclass of ObjectOutputStream that overrides this method, the resolveProxyClass method in the corresponding subclass of ObjectInputStream must read any data or objects written by annotateProxyClass.

Parameters:
cl - the proxy class to annotate custom data for
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - any exception thrown by the underlying OutputStream
Since:
1.3
See Also:
ObjectInputStream.resolveProxyClass(String[]) sample code for java.io.ObjectInputStream.resolveProxyClass(java.lang.String[]) definition code for java.io.ObjectInputStream.resolveProxyClass(java.lang.String[])

replaceObject sample code for java.io.ObjectOutputStream.replaceObject(java.lang.Object) definition code for java.io.ObjectOutputStream.replaceObject(java.lang.Object)

protected Object sample code for java.lang.Object definition code for java.lang.Object  replaceObject(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException 
This method will allow trusted subclasses of ObjectOutputStream to substitute one object for another during serialization. Replacing objects is disabled until enableReplaceObject is called. The enableReplaceObject method checks that the stream requesting to do replacement can be trusted. The first occurrence of each object written into the serialization stream is passed to replaceObject. Subsequent references to the object are replaced by the object returned by the original call to replaceObject. To ensure that the private state of objects is not unintentionally exposed, only trusted streams may use replaceObject.

The ObjectOutputStream.writeObject method takes a parameter of type Object (as opposed to type Serializable) to allow for cases where non-serializable objects are replaced by serializable ones.

When a subclass is replacing objects it must insure that either a complementary substitution must be made during deserialization or that the substituted object is compatible with every field where the reference will be stored. Objects whose type is not a subclass of the type of the field or array element abort the serialization by raising an exception and the object is not be stored.

This method is called only once when each object is first encountered. All subsequent references to the object will be redirected to the new object. This method should return the object to be substituted or the original object.

Null can be returned as the object to be substituted, but may cause NullReferenceException in classes that contain references to the original object since they may be expecting an object instead of null.

Parameters:
obj - the object to be replaced
Returns:
the alternate object that replaced the specified one
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - Any exception thrown by the underlying OutputStream.

enableReplaceObject sample code for java.io.ObjectOutputStream.enableReplaceObject(boolean) definition code for java.io.ObjectOutputStream.enableReplaceObject(boolean)

protected boolean enableReplaceObject(boolean enable)
                               throws SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException 
Enable the stream to do replacement of objects in the stream. When enabled, the replaceObject method is called for every object being serialized.

If enable is true, and there is a security manager installed, this method first calls the security manager's checkPermission method with a SerializablePermission("enableSubstitution") permission to ensure it's ok to enable the stream to do replacement of objects in the stream.

Parameters:
enable - boolean parameter to enable replacement of objects
Returns:
the previous setting before this method was invoked
Throws:
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and its checkPermission method denies enabling the stream to do replacement of objects in the stream.
See Also:
SecurityManager.checkPermission(java.security.Permission) sample code for java.lang.SecurityManager.checkPermission(java.security.Permission) definition code for java.lang.SecurityManager.checkPermission(java.security.Permission) , SerializablePermission sample code for java.io.SerializablePermission definition code for java.io.SerializablePermission

writeStreamHeader sample code for java.io.ObjectOutputStream.writeStreamHeader() definition code for java.io.ObjectOutputStream.writeStreamHeader()

protected void writeStreamHeader()
                          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
The writeStreamHeader method is provided so subclasses can append or prepend their own header to the stream. It writes the magic number and version to the stream.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeClassDescriptor sample code for java.io.ObjectOutputStream.writeClassDescriptor(java.io.ObjectStreamClass) definition code for java.io.ObjectOutputStream.writeClassDescriptor(java.io.ObjectStreamClass)

protected void writeClassDescriptor(ObjectStreamClass sample code for java.io.ObjectStreamClass definition code for java.io.ObjectStreamClass  desc)
                             throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Write the specified class descriptor to the ObjectOutputStream. Class descriptors are used to identify the classes of objects written to the stream. Subclasses of ObjectOutputStream may override this method to customize the way in which class descriptors are written to the serialization stream. The corresponding method in ObjectInputStream, readClassDescriptor, should then be overridden to reconstitute the class descriptor from its custom stream representation. By default, this method writes class descriptors according to the format defined in the Object Serialization specification.

Note that this method will only be called if the ObjectOutputStream is not using the old serialization stream format (set by calling ObjectOutputStream's useProtocolVersion method). If this serialization stream is using the old format (PROTOCOL_VERSION_1), the class descriptor will be written internally in a manner that cannot be overridden or customized.

Parameters:
desc - class descriptor to write to the stream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.
Since:
1.3
See Also:
ObjectInputStream.readClassDescriptor() sample code for java.io.ObjectInputStream.readClassDescriptor() definition code for java.io.ObjectInputStream.readClassDescriptor() , useProtocolVersion(int) sample code for java.io.ObjectOutputStream.useProtocolVersion(int) definition code for java.io.ObjectOutputStream.useProtocolVersion(int) , ObjectStreamConstants.PROTOCOL_VERSION_1 sample code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1 definition code for java.io.ObjectStreamConstants.PROTOCOL_VERSION_1

write sample code for java.io.ObjectOutputStream.write(int) definition code for java.io.ObjectOutputStream.write(int)

public void write(int val)
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a byte. This method will block until the byte is actually written.

Specified by:
write sample code for java.io.DataOutput.write(int) definition code for java.io.DataOutput.write(int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Specified by:
write sample code for java.io.ObjectOutput.write(int) definition code for java.io.ObjectOutput.write(int) in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Specified by:
write sample code for java.io.OutputStream.write(int) definition code for java.io.OutputStream.write(int) in class OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
Parameters:
val - the byte to be written to the stream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.

write sample code for java.io.ObjectOutputStream.write(byte[]) definition code for java.io.ObjectOutputStream.write(byte[])

public void write(byte[] buf)
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes an array of bytes. This method will block until the bytes are actually written.

Specified by:
write sample code for java.io.DataOutput.write(byte[]) definition code for java.io.DataOutput.write(byte[]) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Specified by:
write sample code for java.io.ObjectOutput.write(byte[]) definition code for java.io.ObjectOutput.write(byte[]) in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Overrides:
write sample code for java.io.OutputStream.write(byte[]) definition code for java.io.OutputStream.write(byte[]) in class OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
Parameters:
buf - the data to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.
See Also:
OutputStream.write(byte[], int, int) sample code for java.io.OutputStream.write(byte[], int, int) definition code for java.io.OutputStream.write(byte[], int, int)

write sample code for java.io.ObjectOutputStream.write(byte[], int, int) definition code for java.io.ObjectOutputStream.write(byte[], int, int)

public void write(byte[] buf,
                  int off,
                  int len)
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a sub array of bytes.

Specified by:
write sample code for java.io.DataOutput.write(byte[], int, int) definition code for java.io.DataOutput.write(byte[], int, int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Specified by:
write sample code for java.io.ObjectOutput.write(byte[], int, int) definition code for java.io.ObjectOutput.write(byte[], int, int) in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Overrides:
write sample code for java.io.OutputStream.write(byte[], int, int) definition code for java.io.OutputStream.write(byte[], int, int) in class OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
Parameters:
buf - the data to be written
off - the start offset in the data
len - the number of bytes that are written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.

flush sample code for java.io.ObjectOutputStream.flush() definition code for java.io.ObjectOutputStream.flush()

public void flush()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Flushes the stream. This will write any buffered output bytes and flush through to the underlying stream.

Specified by:
flush sample code for java.io.Flushable.flush() definition code for java.io.Flushable.flush() in interface Flushable sample code for java.io.Flushable definition code for java.io.Flushable
Specified by:
flush sample code for java.io.ObjectOutput.flush() definition code for java.io.ObjectOutput.flush() in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Overrides:
flush sample code for java.io.OutputStream.flush() definition code for java.io.OutputStream.flush() in class OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.

drain sample code for java.io.ObjectOutputStream.drain() definition code for java.io.ObjectOutputStream.drain()

protected void drain()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Drain any buffered data in ObjectOutputStream. Similar to flush but does not propagate the flush to the underlying stream.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

close sample code for java.io.ObjectOutputStream.close() definition code for java.io.ObjectOutputStream.close()

public void close()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Closes the stream. This method must be called to release any resources associated with the stream.

Specified by:
close sample code for java.io.Closeable.close() definition code for java.io.Closeable.close() in interface Closeable sample code for java.io.Closeable definition code for java.io.Closeable
Specified by:
close sample code for java.io.ObjectOutput.close() definition code for java.io.ObjectOutput.close() in interface ObjectOutput sample code for java.io.ObjectOutput definition code for java.io.ObjectOutput
Overrides:
close sample code for java.io.OutputStream.close() definition code for java.io.OutputStream.close() in class OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - If an I/O error has occurred.

writeBoolean sample code for java.io.ObjectOutputStream.writeBoolean(boolean) definition code for java.io.ObjectOutputStream.writeBoolean(boolean)

public void writeBoolean(boolean val)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a boolean.

Specified by:
writeBoolean sample code for java.io.DataOutput.writeBoolean(boolean) definition code for java.io.DataOutput.writeBoolean(boolean) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the boolean to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeByte sample code for java.io.ObjectOutputStream.writeByte(int) definition code for java.io.ObjectOutputStream.writeByte(int)

public void writeByte(int val)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes an 8 bit byte.

Specified by:
writeByte sample code for java.io.DataOutput.writeByte(int) definition code for java.io.DataOutput.writeByte(int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the byte value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeShort sample code for java.io.ObjectOutputStream.writeShort(int) definition code for java.io.ObjectOutputStream.writeShort(int)

public void writeShort(int val)
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 16 bit short.

Specified by:
writeShort sample code for java.io.DataOutput.writeShort(int) definition code for java.io.DataOutput.writeShort(int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the short value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeChar sample code for java.io.ObjectOutputStream.writeChar(int) definition code for java.io.ObjectOutputStream.writeChar(int)

public void writeChar(int val)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 16 bit char.

Specified by:
writeChar sample code for java.io.DataOutput.writeChar(int) definition code for java.io.DataOutput.writeChar(int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the char value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeInt sample code for java.io.ObjectOutputStream.writeInt(int) definition code for java.io.ObjectOutputStream.writeInt(int)

public void writeInt(int val)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 32 bit int.

Specified by:
writeInt sample code for java.io.DataOutput.writeInt(int) definition code for java.io.DataOutput.writeInt(int) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the integer value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeLong sample code for java.io.ObjectOutputStream.writeLong(long) definition code for java.io.ObjectOutputStream.writeLong(long)

public void writeLong(long val)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 64 bit long.

Specified by:
writeLong sample code for java.io.DataOutput.writeLong(long) definition code for java.io.DataOutput.writeLong(long) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the long value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeFloat sample code for java.io.ObjectOutputStream.writeFloat(float) definition code for java.io.ObjectOutputStream.writeFloat(float)

public void writeFloat(float val)
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 32 bit float.

Specified by:
writeFloat sample code for java.io.DataOutput.writeFloat(float) definition code for java.io.DataOutput.writeFloat(float) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the float value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeDouble sample code for java.io.ObjectOutputStream.writeDouble(double) definition code for java.io.ObjectOutputStream.writeDouble(double)

public void writeDouble(double val)
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a 64 bit double.

Specified by:
writeDouble sample code for java.io.DataOutput.writeDouble(double) definition code for java.io.DataOutput.writeDouble(double) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
val - the double value to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeBytes sample code for java.io.ObjectOutputStream.writeBytes(java.lang.String) definition code for java.io.ObjectOutputStream.writeBytes(java.lang.String)

public void writeBytes(String sample code for java.lang.String definition code for java.lang.String  str)
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a String as a sequence of bytes.

Specified by:
writeBytes sample code for java.io.DataOutput.writeBytes(java.lang.String) definition code for java.io.DataOutput.writeBytes(java.lang.String) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
str - the String of bytes to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeChars sample code for java.io.ObjectOutputStream.writeChars(java.lang.String) definition code for java.io.ObjectOutputStream.writeChars(java.lang.String)

public void writeChars(String sample code for java.lang.String definition code for java.lang.String  str)
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Writes a String as a sequence of chars.

Specified by:
writeChars sample code for java.io.DataOutput.writeChars(java.lang.String) definition code for java.io.DataOutput.writeChars(java.lang.String) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
str - the String of chars to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream

writeUTF sample code for java.io.ObjectOutputStream.writeUTF(java.lang.String) definition code for java.io.ObjectOutputStream.writeUTF(java.lang.String)

public void writeUTF(String sample code for java.lang.String definition code for java.lang.String  str)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Primitive data write of this String in modified UTF-8 format. Note that there is a significant difference between writing a String into the stream as primitive data or as an Object. A String instance written by writeObject is written into the stream as a String initially. Future writeObject() calls write references to the string into the stream.

Specified by:
writeUTF sample code for java.io.DataOutput.writeUTF(java.lang.String) definition code for java.io.DataOutput.writeUTF(java.lang.String) in interface DataOutput sample code for java.io.DataOutput definition code for java.io.DataOutput
Parameters:
str - the String to be written
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if I/O errors occur while writing to the underlying stream