com.eteks.sweethome3d.io

Class DefaultHomeOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.eteks.sweethome3d.io.DefaultHomeOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class DefaultHomeOutputStream
extends java.io.FilterOutputStream

An OutputStream filter that writes a home in a stream at .sh3d file format.

Author:

Emmanuel Puybaret

See Also:

DefaultHomeInputStream

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
DefaultHomeOutputStream(java.io.OutputStream out) Creates a stream that will save a home and all the contents it references in an uncompressed zip stream.
DefaultHomeOutputStream(java.io.OutputStream out, int compressionLevel, boolean includeTemporaryContent) Creates a stream that will save a home in a zip stream.
DefaultHomeOutputStream(java.io.OutputStream out, int compressionLevel, ContentRecording contentRecording) Creates a stream that will save a home in a zip stream.
DefaultHomeOutputStream(java.io.OutputStream out, int compressionLevel, ContentRecording contentRecording, boolean serializedHome, HomeXMLExporter homeXmlExporter) Creates a stream that will serialize a home in a zip stream.

Method Summary

Modifier and Type	Method and Description
void	writeHome(Home home) Writes home in a zipped stream followed by Content objects it points to.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHomeOutputStream

public DefaultHomeOutputStream(java.io.OutputStream out)
                        throws java.io.IOException

Creates a stream that will save a home and all the contents it references in an uncompressed zip stream. Home data will be serialized in an entry named Home.

Throws:

java.io.IOException

DefaultHomeOutputStream

public DefaultHomeOutputStream(java.io.OutputStream out,
                               int compressionLevel,
                               boolean includeTemporaryContent)
                        throws java.io.IOException

Creates a stream that will save a home in a zip stream. Home data will be serialized in an entry named Home.

Parameters:

compressionLevel - 0-9

includeTemporaryContent - if true, content instances of TemporaryURLContent and SimpleURLContent classes referenced by the saved home as well as the content previously saved with it will be written. If false, all the content instances referenced by the saved home will be written in the zip stream.

Throws:

java.io.IOException

DefaultHomeOutputStream

public DefaultHomeOutputStream(java.io.OutputStream out,
                               int compressionLevel,
                               ContentRecording contentRecording)
                        throws java.io.IOException

Creates a stream that will save a home in a zip stream. Home data will be serialized in an entry named Home.

Parameters:

compressionLevel - 0-9

contentRecording - how content should be recorded with home.

Throws:

java.io.IOException

DefaultHomeOutputStream

public DefaultHomeOutputStream(java.io.OutputStream out,
                               int compressionLevel,
                               ContentRecording contentRecording,
                               boolean serializedHome,
                               HomeXMLExporter homeXmlExporter)
                        throws java.io.IOException

Creates a stream that will serialize a home in a zip stream. Home data will be serialized in an entry named Home if serializedHome is true, and saved in Home.xml entry at XML format if homeXmlExporter is not null.

Parameters:

compressionLevel - 0-9

contentRecording - specifies how content should be recorded with home

serializedHome - if true, zip stream will include a Home entry containing the serialized home

homeXmlExporter - if not null, sets how a home will be saved in an additional Home.xml entry

Throws:

java.io.IOException

Method Detail

writeHome

public void writeHome(Home home)
               throws java.io.IOException

Writes home in a zipped stream followed by Content objects it points to.

Throws:

java.io.IOException