org.mpxj.json

Class JsonWriter

java.lang.Object

org.mpxj.writer.AbstractProjectWriter

org.mpxj.json.JsonWriter

All Implemented Interfaces:

ProjectWriter

public final class JsonWriter
extends AbstractProjectWriter

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

Constructor Summary

Constructors

Constructor and Description
JsonWriter()

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Retrieve the charset to used when writing the JSON file.
boolean	getIncludeLayoutData() Retrieve a flag indicating if layout data should be included in the output.
boolean	getPretty() Retrieve the pretty-print flag.
TimeUnit	getTimeUnits() Retrieve the time units used for durations.
boolean	getWriteAttributeTypes() Returns true of attribute type information is written to the JSON file.
void	setCharset(Charset charset) Set the charset to used when writing the JSON file.
void	setIncludeLayoutData(boolean includeLayoutData) Set a flag indicating if layout data should be included in the output.
void	setPretty(boolean pretty) Set the pretty-print flag.
void	setTimeUnits(TimeUnit value) Set the time units to use for durations.
void	setWriteAttributeTypes(boolean writeAttributeTypes) Sets the flag used to determine if attribute types are written to the JSON file.
void	write(List<ProjectFile> projects, OutputStream outputStream) Write a file containing multiple projects to the supplied OutputStream instance.
void	write(ProjectFile projectFile, OutputStream stream) 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

JsonWriter

public JsonWriter()

Method Detail

getPretty

public boolean getPretty()

Retrieve the pretty-print flag.

Returns:

true if pretty printing is enabled

setPretty

public void setPretty(boolean pretty)

Set the pretty-print flag.

Parameters:

pretty - true if pretty printing is enabled

getIncludeLayoutData

public boolean getIncludeLayoutData()

Retrieve a flag indicating if layout data should be included in the output. Defaults to false.

Returns:

true if layout data is included

setIncludeLayoutData

public void setIncludeLayoutData(boolean includeLayoutData)

Set a flag indicating if layout data should be included in the output.

Parameters:

includeLayoutData - true if layout data is included

getCharset

public Charset getCharset()

Retrieve the charset to used when writing the JSON file.

Returns:

charset

setCharset

public void setCharset(Charset charset)

Set the charset to used when writing the JSON file.

Parameters:

charset - charset to use

getWriteAttributeTypes

public boolean getWriteAttributeTypes()

Returns true of attribute type information is written to the JSON file.

Returns:

true if attribute types written

setWriteAttributeTypes

public void setWriteAttributeTypes(boolean writeAttributeTypes)

Sets the flag used to determine if attribute types are written to the JSON file.

Parameters:

writeAttributeTypes - set to true to write attribute types

setTimeUnits

public void setTimeUnits(TimeUnit value)

Set the time units to use for durations. Defaults to seconds.

Parameters:

value - time units

getTimeUnits

public TimeUnit getTimeUnits()

Retrieve the time units used for durations. null indicates durations will be written in seconds.

Returns:

time units

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 stream)
           throws IOException

Description copied from interface: ProjectWriter

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

Parameters:

projectFile - project file instance

stream - OutputStream instance

Throws:

IOException