com.eteks.sweethome3d.io

Class DefaultHomeInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.eteks.sweethome3d.io.DefaultHomeInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DefaultHomeInputStream
extends java.io.FilterInputStream

An InputStream filter that reads a home from a stream at .sh3d file format.

Author:

Emmanuel Puybaret

See Also:

DefaultHomeOutputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
DefaultHomeInputStream(java.io.File zipFile, ContentRecording contentRecording, HomeXMLHandler xmlHandler, UserPreferences preferences, boolean preferPreferencesContent) Creates a home input stream able to read a home and its content from the given file.
DefaultHomeInputStream(java.io.InputStream in) Creates a home input stream filter able to read a home and its content from in.
DefaultHomeInputStream(java.io.InputStream in, ContentRecording contentRecording) Creates a home input stream filter able to read a home and its content from in.
DefaultHomeInputStream(java.io.InputStream in, ContentRecording contentRecording, HomeXMLHandler xmlHandler, UserPreferences preferences, boolean preferPreferencesContent) Creates a home input stream filter able to read a home and its content from in.
DefaultHomeInputStream(java.io.InputStream in, ContentRecording contentRecording, UserPreferences preferences, boolean preferPreferencesContent) Creates a home input stream filter able to read a home and its content from in.

Method Summary

Modifier and Type	Method and Description
boolean	isPrefixCorrect() Returns true if the prefix of the read input stream is as expected.
Home	readHome() Reads home from a zipped stream containing a Home.xml or Home entry, or if the stream isn't zipped, reads the input stream as a XML input stream.
protected java.lang.Object	resolveObjectInputStreamObject(java.lang.Object obj) Returns obj or a substitute of it during Home entry deserialization.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHomeInputStream

public DefaultHomeInputStream(java.io.InputStream in)
                       throws java.io.IOException

Creates a home input stream filter able to read a home and its content from in. The dependencies of the read home included in the stream will be checked.

Throws:

java.io.IOException

DefaultHomeInputStream

public DefaultHomeInputStream(java.io.InputStream in,
                              ContentRecording contentRecording)
                       throws java.io.IOException

Creates a home input stream filter able to read a home and its content from in.

Throws:

java.io.IOException

DefaultHomeInputStream

public DefaultHomeInputStream(java.io.InputStream in,
                              ContentRecording contentRecording,
                              UserPreferences preferences,
                              boolean preferPreferencesContent)

Creates a home input stream filter able to read a home and its content from in. If preferences isn't null and preferPreferencesContent is true, the furniture and textures contents it references will replace the one of the read home when they are equal. If preferPreferencesContent is false, preferences content will be used only to replace damaged equal content that might be found in read home files.

DefaultHomeInputStream

public DefaultHomeInputStream(java.io.InputStream in,
                              ContentRecording contentRecording,
                              HomeXMLHandler xmlHandler,
                              UserPreferences preferences,
                              boolean preferPreferencesContent)

Creates a home input stream filter able to read a home and its content from in.

Parameters:

in - the zipped stream from which the home will be read

contentRecording - specifies whether content referenced by the read home is included or not in the stream.

xmlHandler - SAX handler used to parse Home.xml entry when present, or null if only Home entry should taken into account.

preferences - if not null and preferPreferencesContent is true, the furniture and textures contents it references will replace the one of the read home when they are equal. If preferPreferencesContent is false, preferences content will be used only to replace damaged equal content that might be found in read home files.

preferPreferencesContent - if true, the returned home will reference contents in preferences when equal.

DefaultHomeInputStream

public DefaultHomeInputStream(java.io.File zipFile,
                              ContentRecording contentRecording,
                              HomeXMLHandler xmlHandler,
                              UserPreferences preferences,
                              boolean preferPreferencesContent)
                       throws java.io.FileNotFoundException

Creates a home input stream able to read a home and its content from the given file. The file will be read directly without using a temporary copy except if it contains some invalid entries.

Parameters:

zipFile - the zipped file from which the home will be read

contentRecording - specifies whether content referenced by the read home is included or not in the stream.

xmlHandler - SAX handler used to parse Home.xml entry when present, or null if only Home entry should taken into account.

preferences - if not null and preferPreferencesContent is true, the furniture and textures contents it references will replace the one of the read home when they are equal. If preferPreferencesContent is false, preferences content will be used only to replace damaged equal content that might be found in read home files.

preferPreferencesContent - if true, the returned home will reference contents in preferences when equal.

Throws:

java.io.FileNotFoundException - if the given file can't be opened

Method Detail

isPrefixCorrect

public boolean isPrefixCorrect()
                        throws java.io.IOException

Returns true if the prefix of the read input stream is as expected.

Throws:

java.io.IOException

readHome

public Home readHome()
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

Reads home from a zipped stream containing a Home.xml or Home entry, or if the stream isn't zipped, reads the input stream as a XML input stream.

Throws:

java.io.IOException

java.lang.ClassNotFoundException

resolveObjectInputStreamObject

protected java.lang.Object resolveObjectInputStreamObject(java.lang.Object obj)
                                                   throws java.io.IOException

Returns obj or a substitute of it during Home entry deserialization. This method does nothing and returns the obj in parameter. It can be overridden by sub classes if needed.

Throws:

java.io.IOException