Package com.jme3.export

Interface JmeExporter

All Known Implementing Classes:

BinaryExporter, J3MExporter, XMLExporter

public interface JmeExporter

JmeExporter specifies an export implementation for jME3 data.

Method Summary

Modifier and Type	Method	Description
OutputCapsule	getCapsule(Savable object)	Returns the OutputCapsule for the given savable object.
default void	save(Savable object, File f)	Export the Savable to a file.
void	save(Savable object, File f, boolean createDirectories)	Export the Savable to a file.
void	save(Savable object, OutputStream f)	Export the Savable to an OutputStream.

Method Details

save

void save(Savable object,
 OutputStream f)
   throws IOException

Export the Savable to an OutputStream.

Parameters:

object - The savable to export

f - The output stream

Throws:

IOException - If an io exception occurs during export

save

default void save(Savable object,
 File f)
           throws IOException

Export the Savable to a file. If the path to the file doesn't exist, the directories are made.

Parameters:

object - The savable to export

f - The file to export to

Throws:

IOException - If an io exception occurs during export

save

void save(Savable object,
 File f,
 boolean createDirectories)
   throws IOException

Export the Savable to a file. If the path to the file doesn't exist, the parent directories can be created if the createDirectories flag is true. If the path does not exist and createDirectories is false, then an exception is thrown.

Parameters:

object - The savable to export

f - The file to export to

createDirectories - flag to indicate if the directories should be created

Throws:

IOException - If an io exception occurs during export

getCapsule

OutputCapsule getCapsule(Savable object)

Returns the OutputCapsule for the given savable object.

Parameters:

object - The object to retrieve an output capsule for.

Returns:

the OutputCapsule for the given savable object.