Package com.jme3.export.xml

Class XMLExporter

java.lang.Object

com.jme3.export.xml.XMLExporter

All Implemented Interfaces:

JmeExporter

public class XMLExporter
extends Object
implements JmeExporter

Part of the jME XML IO system as introduced in the Google Code jmexml project.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_CLASS
static final String	ATTRIBUTE_DATA
static final String	ATTRIBUTE_REFERENCE
static final String	ATTRIBUTE_REFERENCE_ID
static final String	ATTRIBUTE_SAVABLE_VERSIONS
static final String	ATTRIBUTE_SIZE
static final String	ELEMENT_KEY
static final String	ELEMENT_MAPENTRY
static final String	ELEMENT_VALUE

Constructor Summary

Constructors

Constructor	Description
XMLExporter()

Method Summary

Modifier and Type	Method	Description
OutputCapsule	getCapsule(Savable object)	Returns the OutputCapsule for the given savable object.
static XMLExporter	getInstance()
void	save(Savable object, File f, boolean createDirectories)	Export the Savable to a file.
void	save(Savable object, OutputStream outputStream)	Export the Savable to an OutputStream.
void	setIndentSpaces(int indentSpaces)	Sets the number of spaces used to indent nested tags.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jme3.export.JmeExporter

save

Field Details

ELEMENT_MAPENTRY

public static final String ELEMENT_MAPENTRY

See Also:

• Constant Field Values

ELEMENT_KEY

public static final String ELEMENT_KEY

See Also:

• Constant Field Values

ELEMENT_VALUE

public static final String ELEMENT_VALUE

See Also:

• Constant Field Values

ATTRIBUTE_SIZE

public static final String ATTRIBUTE_SIZE

See Also:

• Constant Field Values

ATTRIBUTE_DATA

public static final String ATTRIBUTE_DATA

See Also:

• Constant Field Values

ATTRIBUTE_CLASS

public static final String ATTRIBUTE_CLASS

See Also:

• Constant Field Values

ATTRIBUTE_REFERENCE_ID

public static final String ATTRIBUTE_REFERENCE_ID

See Also:

• Constant Field Values

ATTRIBUTE_REFERENCE

public static final String ATTRIBUTE_REFERENCE

See Also:

• Constant Field Values

ATTRIBUTE_SAVABLE_VERSIONS

public static final String ATTRIBUTE_SAVABLE_VERSIONS

See Also:

• Constant Field Values

Constructor Details

XMLExporter

public XMLExporter()

Method Details

save

public void save(Savable object,
 OutputStream outputStream)
          throws IOException

Description copied from interface: JmeExporter

Export the Savable to an OutputStream.

Specified by:

save in interface JmeExporter

Parameters:

object - The savable to export

outputStream - The output stream

Throws:

IOException - If an io exception occurs during export

save

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

Description copied from interface: JmeExporter

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.

Specified by:

save in interface JmeExporter

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

public OutputCapsule 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.

setIndentSpaces

public void setIndentSpaces(int indentSpaces)

Sets the number of spaces used to indent nested tags.

Parameters:

indentSpaces - The number of spaces to indent for each level of nesting. Default is 4. Pass 0 to disable pretty printing and write document without adding any whitespace.

getInstance

public static XMLExporter getInstance()