org.mpxj.reader

Interface UniversalProjectReader.ProjectReaderProxy

All Superinterfaces:

AutoCloseable

Enclosing class:

UniversalProjectReader

public static interface UniversalProjectReader.ProjectReaderProxy
extends AutoCloseable

The classes implementing this interface provide access to an instance of the ProjectReader class (via the getProjectReader method) which is the class that UniversalProjectReader has determined should be used to read the file or stream you have passed it. You can use the ProjectReader instance to take decisions in your own code based on the type of file represented by the reader, or you can customize the behaviour of the reader by setting its properties before reading a schedule.

Once you have obtained an instance of the ProjectReaderProxy class, you can call the read or readAll methods to read the schedule data. Note that you must use these methods to read the schedule data from the supplied file or stream rather than calling the read methods on the ProjectReader instance as the UniversalProjectReader has pre-processed the data you supplied to locate the schedule.

Note: you must release the resources held by instances of this class by arranging to call the close method. To assist with this, this interface extends AutoCloseable.

Method Summary

Modifier and Type	Method and Description
ProjectReader	getProjectReader() Retrieve the ProjectReader instance which will be used to read the supplied file or stream.
ProjectFile	read() Read a single ProjectFile instance from the supplied file or stream.
List<ProjectFile>	readAll() Read a list of ProjectFile instances from the supplied file or stream.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getProjectReader

ProjectReader getProjectReader()

Retrieve the ProjectReader instance which will be used to read the supplied file or stream.

Returns:

ProjectReader instance

read

ProjectFile read()
          throws MPXJException

Read a single ProjectFile instance from the supplied file or stream.

Returns:

ProjectFile instance or null

Throws:

MPXJException

readAll

List<ProjectFile> readAll()
                   throws MPXJException

Read a list of ProjectFile instances from the supplied file or stream.

Returns:

ProjectFile instance or an empty list

Throws:

MPXJException