Package org.apache.poi.hpsf

Class PropertySetFactory

java.lang.Object

org.apache.poi.hpsf.PropertySetFactory

public class PropertySetFactory
extends Object

Factory class to create instances of SummaryInformation, DocumentSummaryInformation and PropertySet.

Constructor Summary

Constructors

Constructor	Description
PropertySetFactory()

Method Summary

Modifier and Type	Method	Description
static PropertySet	create(InputStream stream)	Creates the most specific PropertySet from an InputStream.
static PropertySet	create(DirectoryEntry dir, String name)	Creates the most specific PropertySet from an entry in the specified POIFS Directory.
static DocumentSummaryInformation	newDocumentSummaryInformation()	Creates a new document summary information.
static SummaryInformation	newSummaryInformation()	Creates a new summary information.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertySetFactory

public PropertySetFactory()

Method Detail

create

public static PropertySet create(DirectoryEntry dir,
                                 String name)
                          throws FileNotFoundException,
                                 NoPropertySetStreamException,
                                 IOException,
                                 UnsupportedEncodingException

Creates the most specific PropertySet from an entry in the specified POIFS Directory. This is preferrably a DocumentSummaryInformation or a SummaryInformation. If the specified entry does not contain a property set stream, an exception is thrown. If no entry is found with the given name, an exception is thrown.

Parameters:

dir - The directory to find the PropertySet in

name - The name of the entry containing the PropertySet

Returns:

The created PropertySet.

Throws:

FileNotFoundException - if there is no entry with that name

NoPropertySetStreamException - if the stream does not contain a property set.

IOException - if some I/O problem occurs.

UnsupportedEncodingException - if the specified codepage is not supported.

create

public static PropertySet create(InputStream stream)
                          throws NoPropertySetStreamException,
                                 IOException

Creates the most specific PropertySet from an InputStream. This is preferrably a DocumentSummaryInformation or a SummaryInformation. If the specified InputStream does not contain a property set stream, an exception is thrown and the InputStream is repositioned at its beginning.

Parameters:

stream - Contains the property set stream's data.

Returns:

The created PropertySet.

Throws:

NoPropertySetStreamException - if the stream does not contain a property set.

IOException - if some I/O problem occurs.

UnsupportedEncodingException - if the specified codepage is not supported.

newSummaryInformation

public static SummaryInformation newSummaryInformation()

Creates a new summary information.

Returns:

the new summary information.

newDocumentSummaryInformation

public static DocumentSummaryInformation newDocumentSummaryInformation()

Creates a new document summary information.

Returns:

the new document summary information.