com.silverpeas.export
Class ExportDescriptor

java.lang.Object
  com.silverpeas.export.ImportExportDescriptor
      com.silverpeas.export.ExportDescriptor

public class ExportDescriptor
extends ImportExportDescriptor

It represents a descriptor about the export of resources into a writer or an output stream. As such it defines the writer, the output stream and the format into which the resources have to be exported. With the descriptor parameters, additional information about the export process can be passed to the exporter.

Field Summary

Fields inherited from class com.silverpeas.export.ImportExportDescriptor

NO_FORMAT

Constructor Summary

ExportDescriptor()

Method Summary

OutputStream	getOutputStream() Gets the output stream with which the resources have to be exported.
Writer	getWriter() Gets the writer with which the resources have to be exported.
static ExportDescriptor	withOutputStream(OutputStream outputStream) Creates and initializes a new descriptor on an export process with the specified output stream.
static ExportDescriptor	withWriter(Writer writer) Creates and initializes a new descriptor on an export process with the specified writer.

Methods inherited from class com.silverpeas.export.ImportExportDescriptor

getFormat, getParameter, getParameters, inFormat, isParameterSet, setParameter, withoutParameter, withParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportDescriptor

public ExportDescriptor()

Method Detail

withWriter

public static ExportDescriptor withWriter(Writer writer)

Creates and initializes a new descriptor on an export process with the specified writer. The output stream is initialized with the specified writer.

Parameters:

writer - the writer to use for exporting the serializable resources.

Returns:

an export descriptor.

withOutputStream

public static ExportDescriptor withOutputStream(OutputStream outputStream)

Creates and initializes a new descriptor on an export process with the specified output stream. The writer is initialized with the specified output stream.

Parameters:

outputStream - the output stream to use for exporting the serializable resources.

Returns:

an export descriptor.

getWriter

public Writer getWriter()

Gets the writer with which the resources have to be exported.

Returns:

the writer.

getOutputStream

public OutputStream getOutputStream()

Gets the output stream with which the resources have to be exported.

Returns:

the output stream.