Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hpsf »

org.apache.poi.hpsf

Sub Packages:

org.apache.poi.hpsf.basic    
org.apache.poi.hpsf.examples    
org.apache.poi.hpsf.extractor    
org.apache.poi.hpsf.wellknown   Specific support for DocumentSummaryInformation, SummaryInformation types.  

Abstract Classes:

SpecialPropertySet  

Abstract superclass for the convenience classes SummaryInformation and DocumentSummaryInformation .

The motivation behind this class is quite nasty if you look behind the scenes, but it serves the application programmer well by providing him with the easy-to-use SummaryInformation and DocumentSummaryInformation classes. 

code | html
UnsupportedVariantTypeException  

This exception is thrown if HPSF encounters a variant type that isn't supported yet. 

code | html
VariantTypeException  

This exception is thrown if HPSF encounters a problem with a variant type. 

code | html

Classes:

ClassID  

Represents a class ID (16 bytes). 

code | html
Constants  

Defines constants of general use.

 
code | html
CustomProperties  

Maintains the instances of CustomProperty that belong to a DocumentSummaryInformation

code | html
CustomProperty  

This class represents custum properties in the document summary information stream. 

code | html
DocumentSummaryInformation  

Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.

 
code | html
HPSFException  

This exception is the superclass of all other checked exceptions thrown in this package. 

code | html
HPSFRuntimeException  

This exception is the superclass of all other unchecked exceptions thrown in this package. 

code | html
IllegalPropertySetDataException  

This exception is thrown when there is an illegal value set in a PropertySet

code | html
IllegalVariantTypeException  

This exception is thrown if HPSF encounters a variant type that is illegal in the current context.

 
code | html
MarkUnsupportedException  

This exception is thrown if an java.io.InputStream does not support the java.io.InputStream#mark operation.

 
code | html
MissingSectionException  

This exception is thrown if one of the PropertySet 's convenience methods does not find a required Section .

The constructors of this class are analogous to those of its superclass and documented there.

 
code | html
MutableProperty  

Adds writing capability to the Property class.

Please be aware that this class' functionality will be merged into the Property class at a later time, so the API will change.

 
code | html
MutablePropertySet  

Adds writing support to the PropertySet class.

Please be aware that this class' functionality will be merged into the PropertySet class at a later time, so the API will change.

 
code | html
MutableSection  

Adds writing capability to the Section class.

Please be aware that this class' functionality will be merged into the Section class at a later time, so the API will change.

 
code | html
NoFormatIDException  

This exception is thrown if a MutablePropertySet is to be written but does not have a formatID set (see MutableSection#setFormatID(ClassID) or org.apache.poi.hpsf.MutableSection#setFormatID(byte[])

code | html
NoPropertySetStreamException  

This exception is thrown if a format error in a property set stream is detected or when the input data do not constitute a property set stream.

The constructors of this class are analogous to those of its superclass and are documented there.

 
code | html
NoSingleSectionException  

This exception is thrown if one of the PropertySet 's convenience methods that require a single Section is called and the PropertySet does not contain exactly one Section .

The constructors of this class are analogous to those of its superclass and documented there.

 
code | html
Property  

A property in a Section of a PropertySet .

The property's ID gives the property a meaning in the context of its Section

code | html
PropertySet  

Represents a property set in the Horrible Property Set Format (HPSF). 

code | html
PropertySetFactory  

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

 
code | html
ReadingNotSupportedException  

This exception is thrown when HPSF tries to read a (yet) unsupported variant type.

 
code | html
Section  

Represents a section in a PropertySet .

 
code | html
Section.PropertyListEntry  

Represents an entry in the property list and holds a property's ID and its offset from the section's beginning.

 
code | html
SummaryInformation  

Convenience class representing a Summary Information stream in a Microsoft Office document.

 
code | html
Thumbnail  

Class to manipulate data in the Clipboard Variant ( VT_CF ) format.

 
code | html
TypeReader  

Reader for specific data types.

 
code | html
TypeWriter  

Class for writing little-endian data and more.

 
code | html
UnexpectedPropertySetTypeException  

This exception is thrown if a certain type of property set is expected (e.g. 

code | html
Util  

Provides various static utility methods.

 
code | html
Variant  

The Variant types as defined by Microsoft's COM. 

code | html
VariantSupport  

Supports reading and writing of variant data.

FIXME (3): Reading and writing should be made more uniform than it is now. 

code | html
WritingNotSupportedException  

This exception is thrown when trying to write a (yet) unsupported variant type.

 
code | html