Package org.audiveris.proxymusic.mxl

Class Mxl.Input

java.lang.Object

org.audiveris.proxymusic.mxl.Mxl.Input

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

Mxl

public static class Mxl.Input
extends Object
implements Closeable

Class Input allows to read a .mxl file.

Constructor Summary

Constructors

Constructor	Description
Input(File file)	Create an Input object on a provided file.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying zip file.
ZipEntry	getEntry(String entryName)	Report the zip entry related to the provided name.
InputStream	getInputStream(ZipEntry zipEntry)	Report the input stream related to the provided zip entry.
List<RootFile>	getRootFiles()	Report the sequence of root files in the container.

Methods inherited from class java.lang.Object

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

Constructor Details

Input

public Input(File file)
      throws FileNotFoundException,
IOException,
Mxl.MxlException,
javax.xml.bind.JAXBException

Create an Input object on a provided file.

Parameters:

file - the provided file

Throws:

FileNotFoundException

IOException

Mxl.MxlException

javax.xml.bind.JAXBException

Method Details

getEntry

public ZipEntry getEntry(String entryName)
                  throws IOException

Report the zip entry related to the provided name.

Parameters:

entryName - the provided entry name

Returns:

the entry in the .mxl file

Throws:

IOException

getInputStream

public InputStream getInputStream(ZipEntry zipEntry)
                           throws IOException

Report the input stream related to the provided zip entry.

Parameters:

zipEntry - the provided zip entry

Returns:

the corresponding input stream

Throws:

IOException

getRootFiles

public List<RootFile> getRootFiles()

Report the sequence of root files in the container.

Returns:

the (un-mutable) list of RootFile instances

close

public void close()
           throws IOException

Close the underlying zip file.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - propagated from ZipFile.close()