org.mpxj.mpx

Class MPXWriter

java.lang.Object

org.mpxj.writer.AbstractProjectWriter

org.mpxj.mpx.MPXWriter

All Implemented Interfaces:

ProjectWriter

public final class MPXWriter
extends AbstractProjectWriter

This class creates a new MPX file from the contents of a ProjectFile instance.

Constructor Summary

Constructors

Constructor and Description
MPXWriter()

Method Summary

Modifier and Type	Method and Description
Locale	getLocale() This method returns the locale used by this MPX file.
static Locale[]	getSupportedLocales() Retrieves an array of locales supported by this class.
boolean	getUseLocaleDefaults() Retrieves a flag indicating if the default settings for the locale should override any project settings.
void	setLocale(Locale locale) This method sets the locale to be used by this MPX file.
void	setUseLocaleDefaults(boolean useLocaleDefaults) Sets a flag indicating if the default settings for the locale should override any project settings.
void	write(List<ProjectFile> projects, OutputStream outputStream) Write a file containing multiple projects to the supplied OutputStream instance.
void	write(ProjectFile projectFile, OutputStream out) Write a project file's content to the supplied OutputStream instance.

Methods inherited from class org.mpxj.writer.AbstractProjectWriter

write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MPXWriter

public MPXWriter()

Method Detail

write

public void write(List<ProjectFile> projects,
                  OutputStream outputStream)

Description copied from interface: ProjectWriter

Write a file containing multiple projects to the supplied OutputStream instance.

Parameters:

projects - projects to write

outputStream - OutputStream instance

write

public void write(ProjectFile projectFile,
                  OutputStream out)
           throws IOException

Description copied from interface: ProjectWriter

Write a project file's content to the supplied OutputStream instance.

Parameters:

projectFile - project file instance

out - OutputStream instance

Throws:

IOException

getLocale

public Locale getLocale()

This method returns the locale used by this MPX file.

Returns:

current locale

setLocale

public void setLocale(Locale locale)

This method sets the locale to be used by this MPX file.

Parameters:

locale - locale to be used

getUseLocaleDefaults

public boolean getUseLocaleDefaults()

Retrieves a flag indicating if the default settings for the locale should override any project settings.

Returns:

boolean flag.

setUseLocaleDefaults

public void setUseLocaleDefaults(boolean useLocaleDefaults)

Sets a flag indicating if the default settings for the locale should override any project settings.

Parameters:

useLocaleDefaults - boolean flag

getSupportedLocales

public static Locale[] getSupportedLocales()

Retrieves an array of locales supported by this class.

Returns:

array of supported locales