Package org.silverpeas.core.importexport
Class ExportDescriptor
- java.lang.Object
-
- org.silverpeas.core.importexport.ImportExportDescriptor
-
- org.silverpeas.core.importexport.ExportDescriptor
-
public class ExportDescriptor extends ImportExportDescriptor
It represents a descriptor for the export of a resource into a writer or an output stream.It provides the writer or the output stream to use in the export, the MIME type of the format into which the resources have to be exported, and additional properties that can be required by an exporter.
-
-
Field Summary
-
Fields inherited from class org.silverpeas.core.importexport.ImportExportDescriptor
NO_MIMETYPE
-
-
Constructor Summary
Constructors Constructor Description ExportDescriptor()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 org.silverpeas.core.importexport.ImportExportDescriptor
getMimeType, getParameter, getParameters, inMimeType, isParameterSet, setParameter, withoutParameter, withParameter
-
-
-
-
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.
-
-