Package org.audiveris.proxymusic.mxl

Class Mxl.Output

java.lang.Object

org.audiveris.proxymusic.mxl.Mxl.Output

Enclosing class:

Mxl

public static class Mxl.Output
extends Object

Class Output allows to write a .mxl file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Mxl.Output.MxlOutputStream	An OutputStream sub-classed in order to intercept closing.

Constructor Summary

Constructors

Constructor	Description
Output(File file)	Create an Output object on a provided output file.
Output(OutputStream out)	Create an Output object on a provided output stream.

Method Summary

Modifier and Type	Method	Description
ZipEntry	addEntry(RootFile rootFile)	Insert a new RootFile entry into this file.
ZipEntry	addFirstEntry(RootFile rootFile)	Insert the provided RootFile as the FIRST entry.
void	close()	Write the container and close the underlying output stream.
OutputStream	getOutputStream()	Report the underlying Zip output stream.

Methods inherited from class java.lang.Object

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

Constructor Details

Output

public Output(OutputStream out)

Create an Output object on a provided output stream.

Parameters:

out - the provided output stream

Output

public Output(File file)
       throws FileNotFoundException

Create an Output object on a provided output file.

Parameters:

file - the file to write

Throws:

FileNotFoundException

Method Details

addEntry

public ZipEntry addEntry(RootFile rootFile)
                  throws Mxl.MxlException

Insert a new RootFile entry into this file. This populates the internal container and positions the stream output accordingly.

Parameters:

rootFile - the provided RootFile

Returns:

the corresponding Zip entry

Throws:

Mxl.MxlException

addFirstEntry

public ZipEntry addFirstEntry(RootFile rootFile)
                       throws Mxl.MxlException

Insert the provided RootFile as the FIRST entry. This can be called at any time, to populate the internal container in first position, and position the stream output accordingly.

Parameters:

rootFile - the provided RootFile

Returns:

the corresponding Zip entry

Throws:

Mxl.MxlException

close

public void close()
           throws IOException

Write the container and close the underlying output stream.

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()

Report the underlying Zip output stream.

Returns:

the Zip output stream