com.sun.tools.doclets.internal.toolkit
Interface SerializedFormWriter

All Known Implementing Classes:

SerializedFormWriterImpl

public interface SerializedFormWriter

The interface for writing serialized form output. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Nested Class Summary

static interface	SerializedFormWriter.SerialFieldWriter Write the serialized form for a given field.
static interface	SerializedFormWriter.SerialMethodWriter Write the serialized form for a given field.

Method Summary

void	close() Close the writer.
SerializedFormWriter.SerialFieldWriter	getSerialFieldWriter(ClassDoc classDoc) Return an instance of a SerialFieldWriter.
SerializedFormWriter.SerialMethodWriter	getSerialMethodWriter(ClassDoc classDoc) Return an instance of a SerialMethodWriter.
void	writeClassHeader(ClassDoc classDoc) Write the heading for the serializable class.
void	writeFooter() Write the footer.
void	writeHeader(java.lang.String header) Write the given header.
void	writePackageHeader(java.lang.String packageName) Write the given package header.
void	writeSerialUIDInfo(java.lang.String header, java.lang.String serialUID) Write the serial UID info.

Method Detail

writeHeader

void writeHeader(java.lang.String header)

Write the given header.

Parameters:

header - the header to write.

writePackageHeader

void writePackageHeader(java.lang.String packageName)

Write the given package header.

Parameters:

packageName - the package header to write.

writeClassHeader

void writeClassHeader(ClassDoc classDoc)

Write the heading for the serializable class.

Parameters:

classDoc - the class being processed.

writeSerialUIDInfo

void writeSerialUIDInfo(java.lang.String header,
                        java.lang.String serialUID)

Write the serial UID info.

Parameters:

header - the header that will show up before the UID.

serialUID - the serial UID to print.

getSerialFieldWriter

SerializedFormWriter.SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc)

Return an instance of a SerialFieldWriter.

Returns:

an instance of a SerialFieldWriter.

getSerialMethodWriter

SerializedFormWriter.SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc)

Return an instance of a SerialMethodWriter.

Returns:

an instance of a SerialMethodWriter.

close

void close()
           throws java.io.IOException

Close the writer.

Throws:

java.io.IOException

writeFooter

void writeFooter()

Write the footer.