Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hpsf
Class PropertySetFactory

    java.lang.Object
      org.apache.poi.hpsf.PropertySetFactory

    public class PropertySetFactory

extends java.lang.Object

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

Constructor Summary
`PropertySetFactory()`

Method Summary
`static PropertySet` | `create(DirectoryEntry dir, java.lang.String name)` Creates the most specific `PropertySet` from an entry in the specified POIFS Directory.
`static PropertySet` | `create(java.io.InputStream stream)` Creates the most specific `PropertySet` from an `InputStream`.
`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,
                                     java.lang.String name)
                              throws java.io.FileNotFoundException,
                                     NoPropertySetStreamException,
                                     java.io.IOException,
                                     java.io.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:
    `java.io.FileNotFoundException` - if there is no entry with that name
    `NoPropertySetStreamException` - if the stream does not contain a property set.
    `java.io.IOException` - if some I/O problem occurs.
    `java.io.UnsupportedEncodingException` - if the specified codepage is not supported.

### create

    public static PropertySet create(java.io.InputStream stream)
                              throws NoPropertySetStreamException,
                                     MarkUnsupportedException,
                                     java.io.UnsupportedEncodingException,
                                     java.io.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.
    `MarkUnsupportedException` - if the stream does not support the `mark` operation.
    `java.io.IOException` - if some I/O problem occurs.
    `java.io.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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.