com.jme3.export.binary

Class BinaryExporter

java.lang.Object

com.jme3.export.binary.BinaryExporter

All Implemented Interfaces:

JmeExporter

public class BinaryExporter
extends java.lang.Object
implements JmeExporter

Exports to the jME Binary Format. Format descriptor: (each numbered item denotes a series of bytes that follows sequentially one after the next.)

1. "number of classes" - four bytes - int value representing the number of entries in the class lookup table.

CLASS TABLE: There will be X blocks each consisting of numbers 2 thru 9, where X = the number read in 1.

2. "class alias" - 1...X bytes, where X = ((int) FastMath.log(aliasCount, 256) + 1) - an alias used when writing object data to match an object to its appropriate object class type.

3. "full class name size" - four bytes - int value representing number of bytes to read in for next field.

4. "full class name" - 1...X bytes representing a String value, where X = the number read in 3. The String is the fully qualified class name of the Savable class, eg "com.jme.math.Vector3f"

5. "number of fields" - four bytes - int value representing number of blocks to read in next (numbers 6 - 9), where each block represents a field in this class.

6. "field alias" - 1 byte - the alias used when writing out fields in a class. Because it is a single byte, a single class can not save out more than a total of 256 fields.

7. "field type" - 1 byte - a value representing the type of data a field contains. This value is taken from the static fields of com.jme.util.export.binary.BinaryClassField.

8. "field name size" - 4 bytes - int value representing the size of the next field.

9. "field name" - 1...X bytes representing a String value, where X = the number read in 8. The String is the full String value used when writing the current field.

10. "number of unique objects" - four bytes - int value representing the number of data entries in this file.

DATA LOOKUP TABLE: There will be X blocks each consisting of numbers 11 and 12, where X = the number read in 10.

11. "data id" - four bytes - int value identifying a single unique object that was saved in this data file.

12. "data location" - four bytes - int value representing the offset in the object data portion of this file where the object identified in 11 is located.

13. "future use" - four bytes - hardcoded int value 1.

14. "root id" - four bytes - int value identifying the top level object.

OBJECT DATA SECTION: There will be X blocks each consisting of numbers 15 thru 19, where X = the number of unique location values named in 12.

15. "class alias" - see 2.

16. "data length" - four bytes - int value representing the length in bytes of data stored in fields 17 and 18 for this object.

FIELD ENTRY: There will be X blocks each consisting of numbers 18 and 19

17. "field alias" - see 6.

18. "field data" - 1...X bytes representing the field data. The data length is dependent on the field type and contents.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	aliasCount
protected java.util.IdentityHashMap<Savable,com.jme3.export.binary.BinaryIdContentPair>	contentTable
static boolean	debug
protected int	idCount
protected java.util.HashMap<java.lang.Integer,java.lang.Integer>	locationTable
static boolean	useFastBufs

Constructor Summary

Constructors

Constructor and Description
BinaryExporter()

Method Summary

Modifier and Type	Method and Description
protected int	findPrevMatch(com.jme3.export.binary.BinaryIdContentPair oldPair, java.util.ArrayList<com.jme3.export.binary.BinaryIdContentPair> bucket)
protected byte[]	fixClassAlias(byte[] bytes, int width)
protected com.jme3.export.binary.BinaryIdContentPair	generateIdContentPair(com.jme3.export.binary.BinaryClassObject bco)
protected byte[]	generateTag()
com.jme3.export.binary.BinaryOutputCapsule	getCapsule(Savable object) Returns the OutputCapsule for the given savable object.
protected java.lang.String	getChunk(com.jme3.export.binary.BinaryIdContentPair pair)
static BinaryExporter	getInstance()
int	processBinarySavable(Savable object)
void	save(Savable object, java.io.File f) Export the Savable to a file.
void	save(Savable object, java.io.OutputStream os) Export the Savable to an OutputStream.
static <T extends Savable> T	saveAndLoad(AssetManager assetManager, T object) Saves the object into memory then loads it from memory.

Methods inherited from class java.lang.Object

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

Field Detail

aliasCount

protected int aliasCount

idCount

protected int idCount

contentTable

protected java.util.IdentityHashMap<Savable,com.jme3.export.binary.BinaryIdContentPair> contentTable

locationTable

protected java.util.HashMap<java.lang.Integer,java.lang.Integer> locationTable

debug

public static boolean debug

useFastBufs

public static boolean useFastBufs

Constructor Detail

BinaryExporter

public BinaryExporter()

Method Detail

getInstance

public static BinaryExporter getInstance()

saveAndLoad

public static <T extends Savable> T saveAndLoad(AssetManager assetManager,
                                                T object)

Saves the object into memory then loads it from memory. Used by tests to check if the persistence system is working.

Type Parameters:

T - The type of savable.

Parameters:

assetManager - AssetManager to load assets from.

object - The object to save and then load.

Returns:

A new instance that has been saved and loaded from the original object.

save

public void save(Savable object,
                 java.io.OutputStream os)
          throws java.io.IOException

Description copied from interface: JmeExporter

Export the Savable to an OutputStream.

Specified by:

save in interface JmeExporter

Parameters:

object - The savable to export

os - The output stream

Throws:

java.io.IOException - If an io exception occurs during export

getChunk

protected java.lang.String getChunk(com.jme3.export.binary.BinaryIdContentPair pair)

findPrevMatch

protected int findPrevMatch(com.jme3.export.binary.BinaryIdContentPair oldPair,
                            java.util.ArrayList<com.jme3.export.binary.BinaryIdContentPair> bucket)

fixClassAlias

protected byte[] fixClassAlias(byte[] bytes,
                               int width)

save

public void save(Savable object,
                 java.io.File f)
          throws java.io.IOException

Description copied from interface: JmeExporter

Export the Savable to a file.

Specified by:

save in interface JmeExporter

Parameters:

object - The savable to export

f - The file to export to

Throws:

java.io.IOException - If an io exception occurs during export

getCapsule

public com.jme3.export.binary.BinaryOutputCapsule getCapsule(Savable object)

Description copied from interface: JmeExporter

Returns the OutputCapsule for the given savable object.

Specified by:

getCapsule in interface JmeExporter

Parameters:

object - The object to retrieve an output capsule for.

Returns:

the OutputCapsule for the given savable object.

processBinarySavable

public int processBinarySavable(Savable object)
                         throws java.io.IOException

Throws:

java.io.IOException

generateTag

protected byte[] generateTag()

generateIdContentPair

protected com.jme3.export.binary.BinaryIdContentPair generateIdContentPair(com.jme3.export.binary.BinaryClassObject bco)