NPOI.HPSF Adds writing support To the {@link PropertySet} class. Please be aware that this class' functionality will be merged into the {@link PropertySet} class at a later time, so the API will Change. @author Rainer Klute <klute@rainer-klute.de> @since 2003-02-19 Represents a property Set in the Horrible Property Set Format (HPSF). These are usually metadata of a Microsoft Office document. An application that wants To access these metadata should Create an instance of this class or one of its subclasses by calling the factory method {@link PropertySetFactory#Create} and then retrieve the information its needs by calling appropriate methods. {@link PropertySetFactory#Create} does its work by calling one of the constructors {@link PropertySet#PropertySet(InputStream)} or {@link PropertySet#PropertySet(byte[])}. If the constructor's argument is not in the Horrible Property Set Format, i.e. not a property Set stream, or if any other error occurs, an appropriate exception is thrown. A {@link PropertySet} has a list of {@link Section}s, and each {@link Section} has a {@link Property} array. Use {@link #GetSections} To retrieve the {@link Section}s, then call {@link Section#GetProperties} for each {@link Section} To Get hold of the {@link Property} arrays. Since the vast majority of {@link PropertySet}s Contains only a single {@link Section}, the convenience method {@link #GetProperties} returns the properties of a {@link PropertySet}'s {@link Section} (throwing a {@link NoSingleSectionException} if the {@link PropertySet} Contains more (or less) than exactly one {@link Section}). @author Rainer Klute <klute@rainer-klute.de> @author Drew Varner (Drew.Varner hanginIn sc.edu) @since 2002-02-09 If the OS version field holds this value the property Set stream Was Created on a 16-bit Windows system. If the OS version field holds this value the property Set stream Was Created on a Macintosh system. If the OS version field holds this value the property Set stream Was Created on a 32-bit Windows system. The "byteOrder" field must equal this value. Specifies this {@link PropertySet}'s byte order. See the HPFS documentation for details! The "format" field must equal this value. Specifies this {@link PropertySet}'s format. See the HPFS documentation for details! Specifies the version of the operating system that Created this {@link PropertySet}. See the HPFS documentation for details! Specifies this {@link PropertySet}'s "classID" field. See the HPFS documentation for details! The sections in this {@link PropertySet}. Creates an empty (uninitialized) {@link PropertySet} Please note: For the time being this constructor is protected since it is used for internal purposes only, but expect it To become public once the property Set's writing functionality is implemented. Creates a {@link PropertySet} instance from an {@link InputStream} in the Horrible Property Set Format. The constructor Reads the first few bytes from the stream and determines whether it is really a property Set stream. If it Is, it parses the rest of the stream. If it is not, it Resets the stream To its beginning in order To let other components mess around with the data and throws an exception. Holds the data making out the property Set stream. Creates a {@link PropertySet} instance from a byte array that represents a stream in the Horrible Property Set Format. The byte array holding the stream data. The offset in stream where the stream data begin. If the stream data begin with the first byte in the array, the offset is 0. The Length of the stream data. Creates a {@link PropertySet} instance from a byte array that represents a stream in the Horrible Property Set Format. The byte array holding the stream data. The complete byte array contents is the stream data. Checks whether an {@link InputStream} is in the Horrible Property Set Format. The {@link InputStream} To check. In order To perform the check, the method Reads the first bytes from the stream. After Reading, the stream is Reset To the position it had before Reading. The {@link InputStream} must support the {@link InputStream#mark} method. true if the stream is a property Set stream; otherwise, false. Checks whether a byte array is in the Horrible Property Set Format. The byte array To check. The offset in the byte array. The significant number of bytes in the byte array. Only this number of bytes will be checked. true if the byte array is a property Set stream; otherwise, false. Initializes this {@link PropertySet} instance from a byte array. The method assumes that it has been checked alReady that the byte array indeed represents a property Set stream. It does no more checks on its own. Byte array containing the property Set stream The property Set stream starts at this offset Length of the property Set stream. Convenience method returning the value of the property with the specified ID. If the property is not available, null is returned and a subsequent call To {@link #WasNull} will return true . The property ID The property value Convenience method returning the value of a bool property with the specified ID. If the property is not available, false is returned. A subsequent call To {@link #WasNull} will return true To let the caller distinguish that case from a real property value of false. The property ID The property value Convenience method returning the value of the numeric property with the specified ID. If the property is not available, 0 is returned. A subsequent call To {@link #WasNull} will return true To let the caller distinguish that case from a real property value of 0. The property ID The propertyIntValue value Returns true if the PropertySet is equal To the specified parameter, else false. the object To Compare this PropertySet with true if the objects are equal, false if not Serves as a hash function for a particular type. A hash code for the current . Returns a that represents the current . A that represents the current . Gets or sets the property Set stream's low-level "byte order" field. It is always 0xFFFE The property Set stream's low-level "byte order" field.. Gets or sets the property Set stream's low-level "format" field. It is always 0x0000 The property Set stream's low-level "format" field. Returns the property Set stream's low-level "OS version" field. The property Set stream's low-level "OS version" field. Gets or sets the property Set stream's low-level "class ID" The property Set stream's low-level "class ID" field. Returns the number of {@link Section}s in the property Set. The number of {@link Section}s in the property Set. Returns the {@link Section}s in the property Set. {@link Section}s in the property Set. Checks whether this {@link PropertySet} represents a Summary Information. true Checks whether this {@link PropertySet} represents a Summary Information; otherwise, false. Gets a value indicating whether this instance is document summary information. true if this instance is document summary information; otherwise, false. Checks whether this {@link PropertySet} is a Document Summary Information. @return true if this {@link PropertySet} represents a Document Summary Information, else false Convenience method returning the {@link Property} array contained in this property Set. It is a shortcut for Getting the {@link PropertySet}'s {@link Section}s list and then Getting the {@link Property} array from the first {@link Section}. The properties of the only {@link Section} of this {@link PropertySet}. Checks whether the property which the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access Was available or not. This information might be important for callers of {@link #GetPropertyIntValue} since the latter returns 0 if the property does not exist. Using {@link #WasNull}, the caller can distiguish this case from a property's real value of 0. true if the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access a property that Was not available; otherwise, false. Gets the first section. The first section. If the {@link PropertySet} has only a single section this method returns it. The singleSection value Initializes a new instance of the class. Its primary task is To initialize the immutable field with their proper values. It also Sets fields that might Change To reasonable defaults. Initializes a new instance of the class. All nested elements, i.e.Sections and Property instances, will be their mutable counterparts in the new MutablePropertySet. The property Set To copy The Length of the property Set stream header. Removes all sections from this property Set. Adds a section To this property Set. section The {@link Section} To Add. It will be Appended after any sections that are alReady present in the property Set and thus become the last section. Writes the property Set To an output stream. the output stream To Write the section To Returns the contents of this property Set stream as an input stream. The latter can be used for example To Write the property Set into a POIFS document. The input stream represents a snapshot of the property Set. If the latter is modified while the input stream is still being Read, the modifications will not be reflected in the input stream but in the {@link MutablePropertySet} only. the contents of this property Set stream Returns the contents of this property set stream as an input stream. The latter can be used for example to write the property set into a POIFS document. The input stream represents a snapshot of the property set. If the latter is modified while the input stream is still being read, the modifications will not be reflected in the input stream but in the {@link MutablePropertySet} only. the contents of this property set stream Writes a property Set To a document in a POI filesystem directory The directory in the POI filesystem To Write the document To. The document's name. If there is alReady a document with the same name in the directory the latter will be overwritten. Gets or sets the "byteOrder" property. the byteOrder value To Set Gets or sets the "format" property. the format value To Set Gets or sets the "osVersion" property the osVersion value To Set. Gets or sets the property Set stream's low-level "class ID" The property Set stream's low-level "class ID" field. This exception is thrown when trying To Write a (yet) unsupported variant type. @see ReadingNotSupportedException @see UnsupportedVariantTypeException @author Rainer Klute <klute@rainer-klute.de> @since 2003-08-08 This exception is thrown if HPSF encounters a variant type that isn't supported yet. Although a variant type is unsupported the value can still be retrieved using the {@link VariantTypeException#GetValue} method. Obviously this class should disappear some day. @author Rainer Klute <klute@rainer-klute.de> @since 2003-08-05 This exception is thrown if HPSF encounters a problem with a variant type. Concrete subclasses specifiy the problem further. @author Rainer Klute <klute@rainer-klute.de> @since 2004-06-21 This exception is the superclass of all other checked exceptions thrown in this package. It supports a nested "reason" throwable, i.e. an exception that caused this one To be thrown. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The message string. Initializes a new instance of the class. The reason, i.e. a throwable that indirectly caused this exception. Initializes a new instance of the class. The message string. The reason, i.e. a throwable that indirectly caused this exception. Returns the {@link Exception} that caused this exception To be thrown or null if there was no such {@link Exception}. The reason. Initializes a new instance of the class. The variant type causing the problem The value who's variant type causes the problem A message text describing the problem Gets the offending variant type the offending variant type. Returns the value who's variant type caused the problem. the value who's variant type caused the problem. Initializes a new instance of the class. The unsupported variant type The value who's variant type is not yet supported Initializes a new instance of the class. The unsupported variant type. The value A property in a {@link Section} of a {@link PropertySet}. The property's ID gives the property a meaning in the context of its {@link Section}. Each {@link Section} spans its own name space of property IDs. The property's type determines how its value is interpreted. For example, if the type Is {@link Variant#VT_LPSTR} (byte string), the value consists of a DWord telling how many bytes the string Contains. The bytes follow immediately, including any null bytes that terminate the string. The type {@link Variant#VT_I4} denotes a four-byte integer value, {@link Variant#VT_FILETIME} some DateTime and time (of a file). Please note that not all {@link Variant} types yet. This might Change over time but largely depends on your feedback so that the POI team knows which variant types are really needed. So please feel free To submit error reports or patches for the types you need. Microsoft documentation: Property Set Display Name Dictionary . @author Rainer Klute <klute@rainer-klute.de> @author Drew Varner (Drew.Varner InAndAround sc.edu) @see Section @see Variant @since 2002-02-09 The property's ID. The property's type. The property's value. Initializes a new instance of the class. the property's ID. the property's type, see {@link Variant}. the property's value. Only certain types are allowed, see {@link Variant}. Initializes a new instance of the class. The property's ID. The bytes the property Set stream consists of. The property's type/value pair's offset in the section. The property's type/value pair's Length in bytes. The section's and thus the property's codepage. It is needed only when Reading string values Initializes a new instance of the class. Reads the dictionary. The byte array containing the bytes making out the dictionary. At this offset within src the dictionary starts. The dictionary Contains at most this many bytes. The codepage of the string values. The dictonary Compares two properties. Please beware that a property with ID == 0 is a special case: It does not have a type, and its value is the section's dictionary. Another special case are strings: Two properties may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR; The o. Typeses the are equal. The t1. The t2. Serves as a hash function for a particular type. A hash code for the current . Returns a that represents the current . A that represents the current . Returns the property's ID. @return The ID value Returns the property's type. @return The type value Gets the property's value. The property's value Gets the property's size in bytes. This is always a multiple of 4. the property's size in bytes This class represents custum properties in the document summary information stream. The difference To normal properties is that custom properties have an optional name. If the name is not null it will be maintained in the section's dictionary. @author Rainer Klute <klute@rainer-klute.de> @since 2006-02-09 Adds writing capability To the {@link Property} class. Please be aware that this class' functionality will be merged into the {@link Property} class at a later time, so the API will Change. @author Rainer Klute <klute@rainer-klute.de> @since 2003-08-03 Creates an empty property. It must be Filled using the Set method To be usable. Initializes a new instance of the class. The property To copy. Writes the property To an output stream. The output stream To Write To. The codepage To use for writing non-wide strings the number of bytes written To the stream Initializes a new instance of the class. Initializes a new instance of the class. the property To copy Initializes a new instance of the class. This property's attributes are copied To the new custom property. The new custom property's name. Compares two custom properties for equality. The method returns true if all attributes of the two custom properties are equal. The custom property To Compare with. true if both custom properties are equal, else false @see Object#GetHashCode() Gets or sets the property's name. the property's name. This exception is thrown if an {@link java.io.InputStream} does not support the {@link java.io.InputStream#mark} operation. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string. Initializes a new instance of the class. This exception's underlying reason. Initializes a new instance of the class. The exception's message string This exception's underlying reason The Variant types as defined by Microsoft's COM. I found this information in http://www.marin.clara.net/COM/variant_type_definitions.htm. In the variant types descriptions the following shortcuts are used: [V] - may appear in a VARIANT, [T] - may appear in a TYPEDESC, [P] - may appear in an OLE property Set, [S] - may appear in a Safe Array. @author Rainer Klute (klute@rainer-klute.de) @since 2002-02-09 [V][P] Nothing, i.e. not a single byte of data. [V][P] SQL style Null. [V][T][P][S] 2 byte signed int. [V][T][P][S] 4 byte signed int. [V][T][P][S] 4 byte real. [V][T][P][S] 8 byte real. [V][T][P][S] currency. How long is this? How is it To be interpreted? [V][T][P][S] DateTime. How long is this? How is it To be interpreted? [V][T][P][S] OLE Automation string. How long is this? How is it To be interpreted? [V][T][P][S] IDispatch *. How long is this? How is it To be interpreted? [V][T][S] SCODE. How long is this? How is it To be interpreted? [V][T][P][S] True=-1, False=0. [V][T][P][S] VARIANT *. How long is this? How is it To be interpreted? [V][T][S] IUnknown *. How long is this? How is it To be interpreted? [V][T][S] 16 byte fixed point. [T] signed char. [V][T][P][S] unsigned char. [T][P] unsigned short. [T][P] unsigned int. [T][P] signed 64-bit int. [T][P] unsigned 64-bit int. [T] signed machine int. [T] unsigned machine int. [T] C style void. [T] Standard return type. How long is this? How is it To be interpreted? [T] pointer type. How long is this? How is it To be interpreted? [T] (use VT_ARRAY in VARIANT). [T] C style array. How long is this? How is it To be interpreted? [T] user defined type. How long is this? How is it To be interpreted? [T][P] null terminated string. [T][P] wide (Unicode) null terminated string. [P] FILETIME. The FILETIME structure holds a DateTime and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. This 64-bit value is split into the two dwords stored in the structure. [P] Length prefixed bytes. [P] Name of the stream follows. [P] Name of the storage follows. [P] Stream Contains an object. How long is this? How is it To be interpreted? [P] Storage Contains an object. How long is this? How is it To be interpreted? [P] Blob Contains an object. How long is this? How is it To be interpreted? [P] Clipboard format. How long is this? How is it To be interpreted? [P] A Class ID. It consists of a 32 bit unsigned integer indicating the size of the structure, a 32 bit signed integer indicating (Clipboard Format Tag) indicating the type of data that it Contains, and then a byte array containing the data. The valid Clipboard Format Tags are:
  • {@link Thumbnail#CFTAG_WINDOWS}
  • {@link Thumbnail#CFTAG_MACINTOSH}
  • {@link Thumbnail#CFTAG_NODATA}
  • {@link Thumbnail#CFTAG_FMTID}
typedef struct tagCLIPDATA {
             // cbSize is the size of the buffer pointed To
             // by pClipData, plus sizeof(ulClipFmt)
             ULONG              cbSize;
             long               ulClipFmt;
             BYTE*              pClipData;
             } CLIPDATA;
See msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp. [P] simple counted array. How long is this? How is it To be interpreted? [V] SAFEARRAY*. How long is this? How is it To be interpreted? [V] void* for local use. How long is this? How is it To be interpreted? FIXME (3): Document this! FIXME (3): Document this! FIXME (3): Document this! FIXME (3): Document this! Denotes a variant type with a Length that is unknown To HPSF yet. Denotes a variant type with a variable Length. Denotes a variant type with a Length of 0 bytes. Denotes a variant type with a Length of 2 bytes. Denotes a variant type with a Length of 4 bytes. Denotes a variant type with a Length of 8 bytes. Maps the numbers denoting the variant types To their corresponding variant type names. Returns the variant type name associated with a variant type number. The variant type number. The variant type name or the string "unknown variant type" Returns a variant type's Length. The variant type number. The Length of the variant type's data in bytes. If the Length Is variable, i.e. the Length of a string, -1 is returned. If HPSF does not know the Length, -2 is returned. The latter usually indicates an unsupported variant type. Convenience class representing a DocumentSummary Information stream in a Microsoft Office document. @author Rainer Klute klute@rainer-klute.de @author Drew Varner (Drew.Varner cloSeto sc.edu) @author robert_flaherty@hyperion.com @since 2002-02-09 Abstract superclass for the convenience classes {@link SummaryInformation} and {@link 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 {@link SummaryInformation} and {@link DocumentSummaryInformation} classes. When parsing the data a property Set stream consists of (possibly coming from an {@link java.io.Stream}) we want To Read and process each byte only once. Since we don't know in advance which kind of property Set we have, we can expect only the most general {@link PropertySet}. Creating a special subclass should be as easy as calling the special subclass' constructor and pass the general {@link PropertySet} in. To make things easy internally, the special class just holds a reference To the general {@link PropertySet} and delegates all method calls To it. A cleaner implementation would have been like this: The {@link PropertySetFactory} parses the stream data into some internal object first. Then it Finds out whether the stream is a {@link SummaryInformation}, a {@link DocumentSummaryInformation} or a general {@link PropertySet}. However, the current implementation went the other way round historically: the convenience classes came only late To my mind. @author Rainer Klute klute@rainer-klute.de @since 2002-02-09 The "real" property Set SpecialPropertySet delegates To. Initializes a new instance of the class. The property Set To be encapsulated by the SpecialPropertySet Initializes a new instance of the class. The mutable property Set To be encapsulated by the SpecialPropertySet Adds a section To this property set. The {@link Section} To Add. It will be Appended after any sections that are alReady present in the property Set and thus become the last section. Removes all sections from this property Set. Returns the contents of this property Set stream as an input stream. The latter can be used for example To Write the property Set into a POIFS document. The input stream represents a snapshot of the property Set. If the latter is modified while the input stream is still being Read, the modifications will not be reflected in the input stream but in the {@link MutablePropertySet} only. the contents of this PropertySet stream Writes a property Set To a document in a POI filesystem directory. The directory in the POI filesystem To Write the document To The document's name. If there is alReady a document with the same name in the directory the latter will be overwritten. Writes the property Set To an output stream. the output stream To Write the section To Returns true if the PropertySet is equal To the specified parameter, else false. the object To Compare this PropertySet with true if the objects are equal, false if not Convenience method returning the value of the property with the specified ID. If the property is not available, null is returned and a subsequent call To {@link #WasNull} will return true . The property ID The property value Convenience method returning the value of a bool property with the specified ID. If the property is not available, false is returned. A subsequent call To {@link #WasNull} will return true To let the caller distinguish that case from a real property value of false. The property ID The property value Convenience method returning the value of the numeric property with the specified ID. If the property is not available, 0 is returned. A subsequent call To {@link #WasNull} will return true To let the caller distinguish that case from a real property value of 0. The property ID The propertyIntValue value Serves as a hash function for a particular type. A hash code for the current . Returns a that represents the current . A that represents the current . The id to name mapping of the properties in this set. gets or sets the "byteOrder" property. the byteOrder value To Set gets or sets the "format" property the format value To Set gets or sets the property Set stream's low-level "class ID" field. The property Set stream's low-level "class ID" field Returns the number of {@link Section}s in the property Set. The number of {@link Section}s in the property Set. Checks whether this {@link PropertySet} represents a Summary Information. true Checks whether this {@link PropertySet} represents a Summary Information; otherwise, false. Gets a value indicating whether this instance is document summary information. true if this instance is document summary information; otherwise, false. Checks whether this {@link PropertySet} is a Document Summary Information. @return true if this {@link PropertySet} represents a Document Summary Information, else false Gets the PropertySet's first section. The {@link PropertySet}'s first section. gets or sets the "osVersion" property the osVersion value To Set Convenience method returning the {@link Property} array contained in this property Set. It is a shortcut for Getting the {@link PropertySet}'s {@link Section}s list and then Getting the {@link Property} array from the first {@link Section}. The properties of the only {@link Section} of this {@link PropertySet}. Checks whether the property which the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access Was available or not. This information might be important for callers of {@link #GetPropertyIntValue} since the latter returns 0 if the property does not exist. Using {@link #WasNull}, the caller can distiguish this case from a property's real value of 0. true if the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access a property that Was not available; otherwise, false. The document name a document summary information stream usually has in a POIFS filesystem. Initializes a new instance of the class. A property Set which should be Created from a document summary information stream. Removes the category. Removes the presentation format. Removes the byte count. Removes the line count. Removes the par count. Removes the slide count. Removes the note count. Removes the hidden count. Removes the MMClip count. Removes the scale. Removes the heading pair. Removes the doc parts. Removes the manager. Removes the company. Removes the links dirty. Creates section 2 if it is not alReady present. Removes the custom properties. Gets or sets the category. The category value Gets or sets the presentation format (or null). The presentation format value Gets or sets the byte count or 0 if the {@link DocumentSummaryInformation} does not contain a byte count. The byteCount value Gets or sets the line count or 0 if the {@link DocumentSummaryInformation} does not contain a line count. The line count value. Gets or sets the par count or 0 if the {@link DocumentSummaryInformation} does not contain a par count. The par count value Gets or sets the slide count or 0 if the {@link DocumentSummaryInformation} does not contain a slide count. The slide count value Gets or sets the note count or 0 if the {@link DocumentSummaryInformation} does not contain a note count The note count value Gets or sets the hidden count or 0 if the {@link DocumentSummaryInformation} does not contain a hidden count. The hidden count value. Returns the mmclip count or 0 if the {@link DocumentSummaryInformation} does not contain a mmclip count. The mmclip count value. Gets or sets a value indicating whether this is scale. true if cropping is desired; otherwise, false. Gets or sets the heading pair (or null) The heading pair value. Gets or sets the doc parts. The doc parts value Gets or sets the manager (or null). The manager value Gets or sets the company (or null). The company value Gets or sets a value indicating whether [links dirty]. true if the custom links are dirty.; otherwise, false. Gets or sets the custom properties. The custom properties. This exception is thrown if a certain type of property Set Is expected (e.g. a Document Summary Information) but the provided property Set is not of that type. The constructors of this class are analogous To those of its superclass and documented there. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The message string. Initializes a new instance of the class. The reason, i.e. a throwable that indirectly caused this exception. Initializes a new instance of the class. The message string. The reason, i.e. a throwable that indirectly caused this exception. This exception is thrown if one of the {@link PropertySet}'s convenience methods does not Find a required {@link Section}. The constructors of this class are analogous To those of its superclass and documented there. @author Rainer Klute <klute@rainer-klute.de> @since 2006-02-08 This exception is the superclass of all other unchecked exceptions thrown in this package. It supports a nested "reason" throwable, i.e. an exception that caused this one To be thrown. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The message string. Initializes a new instance of the class. The reason, i.e. a throwable that indirectly caused this exception. Initializes a new instance of the class. The message string. The reason, i.e. a throwable that indirectly caused this exception. Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string Initializes a new instance of the class. This exception's underlying reason. Initializes a new instance of the class. The exception's message string This exception's underlying reason This exception is thrown if one of the {@link PropertySet}'s convenience methods that require a single {@link Section} is called and the {@link PropertySet} does not contain exactly one {@link Section}. The constructors of this class are analogous To those of its superclass and documented there. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string Initializes a new instance of the class. This exception's underlying reason Initializes a new instance of the class. The exception's message string This exception's underlying reason This exception is thrown if HPSF encounters a variant type that is illegal in the current context. @author Rainer Klute <klute@rainer-klute.de> @since 2004-06-21 Initializes a new instance of the class. The unsupported variant type The value A message string Initializes a new instance of the class. The unsupported variant type The value. Supports Reading and writing of variant data. FIXME (3): Reading and writing should be made more uniform than it is now. The following items should be resolved: Reading requires a Length parameter that is 4 byte greater than the actual data, because the variant type field is included. Reading Reads from a byte array while writing Writes To an byte array output stream. @author Rainer Klute <klute@rainer-klute.de> @since 2003-08-08 Keeps a list of the variant types an "unsupported" message has alReady been issued for. Writes a warning To System.err that a variant type Is unsupported by HPSF. Such a warning is written only once for each variant type. Log messages can be turned on or off by The exception To log HPSF is able To Read these {@link Variant} types. Checks whether HPSF supports the specified variant type. Unsupported types should be implemented included in the {@link #SUPPORTED_TYPES} array. the variant type To check true if HPFS supports this type,otherwise, false. Reads a variant type from a byte array The byte array The offset in the byte array where the variant starts The Length of the variant including the variant type field The variant type To Read The codepage To use for non-wide strings A Java object that corresponds best To the variant field. For example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a {@link String}. Writes a variant value To an output stream. This method ensures that always a multiple of 4 bytes is written. If the codepage is UTF-16, which is encouraged, strings must always be written as {@link Variant#VT_LPWSTR} strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this by Converting strings appropriately, if needed. The stream To Write the value To. The variant's type. The variant's value. The codepage To use To Write non-wide strings The number of entities that have been written. In many cases an "entity" is a byte but this is not always the case. Checks whether logging of unsupported variant types warning is turned on or off. true if logging is turned on; otherwise, false. This exception is thrown when HPSF tries To Read a (yet) unsupported variant type. @see WritingNotSupportedException @see UnsupportedVariantTypeException @author Rainer Klute <klute@rainer-klute.de> @since 2003-08-08 Initializes a new instance of the class. The unsupported variant type The value who's variant type is not yet supported Maps section format IDs To {@link PropertyIDMap}s. It Is initialized with two well-known section format IDs: those of the \005SummaryInformation stream and the \005DocumentSummaryInformation stream. If you have a section format ID you can use it as a key To query this map. If you Get a {@link PropertyIDMap} returned your section is well-known and you can query the {@link PropertyIDMap} for PID strings. If you Get back null you are on your own. This {@link java.util.Map} expects the byte arrays of section format IDs as keys. A key maps To a {@link PropertyIDMap} describing the property IDs in sections with the specified section format ID. @author Rainer Klute (klute@rainer-klute.de) @since 2002-02-09 The SummaryInformation's section's format ID. The DocumentSummaryInformation's first and second sections' format ID. A property without a known name is described by this string. The default section ID map. It maps section format IDs To {@link PropertyIDMap}s. Returns the singleton instance of the default {@link SectionIDMap}. The instance value Returns the property ID string that is associated with a given property ID in a section format ID's namespace. Each section format ID has its own name space of property ID strings and thus must be specified. The property ID The well-known property ID string associated with the property ID pid in the name space spanned by sectionFormatID If the pid sectionFormatID combination is not well-known, the string "[undefined]" is returned. Returns the {@link PropertyIDMap} for a given section format ID. The section format ID. the property ID map Returns the {@link PropertyIDMap} for a given section format ID. A section format ID as a byte[] the property ID map Associates a section format ID with a {@link PropertyIDMap}. the section format ID The property ID map. Puts the specified key. This parameter remains undocumented since the method Is deprecated. This parameter remains undocumented since the method Is deprecated. The return value remains undocumented since the method Is deprecated. Represents a section in a {@link PropertySet}. @author Rainer Klute <klute@rainer-klute.de> @author Drew Varner (Drew.Varner allUpIn sc.edu) @since 2002-02-09 Maps property IDs To section-private PID strings. These strings can be found in the property with ID 0. The section's format ID, {@link #GetFormatID}. Creates an empty and uninitialized {@link Section}. Creates a {@link Section} instance from a byte array. Contains the complete property Set stream. The position in the stream that points To the section's format ID. Returns the value of the property with the specified ID. If the property is not available, null is returned and a subsequent call To {@link #wasNull} will return true. @param id The property's ID @return The property's value Returns the value of the numeric property with the specified ID. If the property is not available, 0 is returned. A subsequent call To {@link #wasNull} will return true To let the caller distinguish that case from a real property value of 0. @param id The property's ID @return The property's value Returns the value of the bool property with the specified ID. If the property is not available, false Is returned. A subsequent call To {@link #wasNull} will return true To let the caller distinguish that case from a real property value of false. @param id The property's ID @return The property's value This member is true if the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access a property that was not available, else false. Returns the PID string associated with a property ID. The ID is first looked up in the {@link Section}'s private dictionary. If it is not found there, the method calls {@link SectionIDMap#GetPIDString}. The property ID. The property ID's string value Checks whether this section is equal To another object. The result Is false if one of the the following conditions holds:
  • The other object is not a {@link Section}.
  • The format IDs of the two sections are not equal.
  • The sections have a different number of properties. However, properties with ID 1 (codepage) are not counted.
  • The other object is not a {@link Section}.
  • The properties have different values. The order of the properties is irrelevant.
@param o The object To Compare this section with @return true if the objects are equal, false if not Removes a field from a property array. The resulting array Is compactified and returned. The property array. The index of the field To be Removed. the compactified array. Serves as a hash function for a particular type. A hash code for the current . Returns a that represents the current . A that represents the current . Returns the format ID. The format ID is the "type" of the section. For example, if the format ID of the first {@link Section} Contains the bytes specified by org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID the section (and thus the property Set) is a SummaryInformation. The format ID. Gets the offset of the section in the stream. The offset of the section in the stream Returns the section's size in bytes. The section's size in bytes. Returns the number of properties in this section. The number of properties in this section. Returns this section's properties. This section's properties. Checks whether the property which the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access was available or not. This information might be important for callers of {@link #GetPropertyIntValue} since the latter returns 0 if the property does not exist. Using {@link #wasNull} the caller can distiguish this case from a property's real value of 0. true if the last call To {@link #GetPropertyIntValue} or {@link #GetProperty} tried To access a property that was not available; otherwise, false. Gets the section's dictionary. A dictionary allows an application To use human-Readable property names instead of numeric property IDs. It Contains mappings from property IDs To their associated string values. The dictionary is stored as the property with ID 0. The codepage for the strings in the dictionary is defined by property with ID 1. the dictionary or null if the section does not have a dictionary. Gets the section's codepage, if any. The section's codepage if one is defined, else -1. Represents an entry in the property list and holds a property's ID and its offset from the section's beginning. Compares this {@link PropertyListEntry} with another one by their offsets. A {@link PropertyListEntry} is "smaller" than another one if its offset from the section's begin is smaller. @see Comparable#CompareTo(java.lang.Object) 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. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string Initializes a new instance of the class. This exception's underlying reason Initializes a new instance of the class. The exception's message string This exception's underlying reason Adds writing capability To the {@link Section} class. Please be aware that this class' functionality will be merged into the {@link Section} class at a later time, so the API will Change. @since 2002-02-20 If the "dirty" flag is true, the section's size must be (re-)calculated before the section is written. List To assemble the properties. Unfortunately a wrong decision has been taken when specifying the "properties" field as an Property[]. It should have been a {@link java.util.List}. Contains the bytes making out the section. This byte array is established when the section's size is calculated and can be reused later. It is valid only if the "dirty" flag is false. Initializes a new instance of the class. Constructs a MutableSection by doing a deep copy of an existing Section. All nested Property instances, will be their mutable counterparts in the new MutableSection. The section Set To copy Sets the section's format ID. The section's format ID Sets the section's format ID. The section's format ID as a byte array. It components are in big-endian format. Sets this section's properties. Any former values are overwritten. This section's new properties. Sets the string value of the property with the specified ID. The property's ID The property's value. It will be written as a Unicode string. Sets the int value of the property with the specified ID. The property's ID The property's value. Sets the long value of the property with the specified ID. The property's ID The property's value. Sets the bool value of the property with the specified ID. The property's ID The property's value. Sets the value and the variant type of the property with the specified ID. If a property with this ID is not yet present in the section, it will be Added. An alReady present property with the specified ID will be overwritten. A default mapping will be used To choose the property's type. The property's ID. The property's variant type. The property's value. Sets the property. The property To be Set. Removes the property. The ID of the property To be Removed Sets the value of the bool property with the specified ID. The property's ID The property's value Calculates the section's size. It is the sum of the Lengths of the section's header (8), the properties list (16 times the number of properties) and the properties themselves. the section's Length in bytes. Writes this section into an output stream. Internally this is done by writing into three byte array output streams: one for the properties, one for the property list and one for the section as such. The two former are Appended To the latter when they have received all their data. The stream To Write into. The number of bytes written, i.e. the section's size. Writes the section's dictionary The output stream To Write To. The dictionary. The codepage To be used To Write the dictionary items. The number of bytes written see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx Ensures the properties. Gets a property. The ID of the property To Get The property or null if there is no such property Sets the property. The property ID. The property's value. The value's class must be one of those supported by HPSF. Removes all properties from the section including 0 (dictionary) and 1 (codepage). Returns the section's size in bytes. The section's size in bytes. OverWrites the base class' method To cope with a redundancy: the property count is maintained in a separate member variable, but shouldn't. The number of properties in this section. Returns this section's properties. This section's properties. Sets the section's dictionary. All keys in the dictionary must be {@link java.lang.long} instances, all values must be {@link java.lang.String}s. This method overWrites the properties with IDs 0 and 1 since they are reserved for the dictionary and the dictionary's codepage. Setting these properties explicitly might have surprising effects. An application should never do this but always use this method. the dictionary Gets the section's codepage, if any. The section's codepage if one is defined, else -1. Maintains the instances of {@link CustomProperty} that belong To a {@link DocumentSummaryInformation}. The class maintains the names of the custom properties in a dictionary. It implements the {@link Map} interface and by this provides a simplified view on custom properties: A property's name is the key that maps To a typed value. This implementation hides property IDs from the developer and regards the property names as keys To typed values. While this class provides a simple API To custom properties, it ignores the fact that not names, but IDs are the real keys To properties. Under the hood this class maintains a 1:1 relationship between IDs and names. Therefore you should not use this class To process property Sets with several IDs mapping To the same name or with properties without a name: the result will contain only a subSet of the original properties. If you really need To deal such property Sets, use HPSF's low-level access methods. An application can call the {@link #isPure} method To check whether a property Set parsed by {@link CustomProperties} is still pure (i.e. unmodified) or whether one or more properties have been dropped. This class is not thRead-safe; concurrent access To instances of this class must be syncronized. @author Rainer Klute <klute@rainer-klute.de> @since 2006-02-09 Maps property IDs To property names. Maps property names To property IDs. Tells whether this object is pure or not. Puts a {@link CustomProperty} into this map. It is assumed that the {@link CustomProperty} alReady has a valid ID. Otherwise use {@link #Put(CustomProperty)}. The name. The custom property. Puts a {@link CustomProperty} that has not yet a valid ID into this map. The method will allocate a suitable ID for the custom property:
  • If there is alReady a property with the same name, take the ID of that property.
  • Otherwise Find the highest ID and use its value plus one.
 The custom property. If the was alReady a property with the same name, the Removes a custom property. The name of the custom property To Remove The Removed property or null if the specified property was not found. Adds a named string property. The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Adds a named long property The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Adds a named double property. The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Adds a named integer property. The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Adds a named bool property. The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Adds a named date property. The property's name. The property's value. the property that was stored under the specified name before, or null if there was no such property before. Gets the with the specified name. the value or null if a value with the specified name is not found in the custom properties. Gets the dictionary which Contains IDs and names of the named custom properties. The dictionary. Gets or sets the codepage. The codepage. Tells whether this {@link CustomProperties} instance is pure or one or more properties of the underlying low-level property Set has been dropped. true if this instance is pure; otherwise, false. This exception is thrown when there is an illegal value Set in a {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must have a value of -1 (true) or 0 (false). Any other value would trigger this exception. It supports a nested "reason" throwable, i.e. an exception that caused this one To be thrown. @author Drew Varner(Drew.Varner atDomain sc.edu) @since 2002-05-26 Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string Initializes a new instance of the class. This exception's underlying reason Initializes a new instance of the class. The exception's message string This exception's underlying reason This is a dictionary which maps property ID values To property ID strings. The methods {@link #GetSummaryInformationProperties} and {@link #GetDocumentSummaryInformationProperties} return singleton {@link PropertyIDMap}s. An application that wants To extend these maps should treat them as unmodifiable, copy them and modifiy the copies. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 ID of the property that denotes the document's title ID of the property that denotes the document's subject ID of the property that denotes the document's author ID of the property that denotes the document's keywords ID of the property that denotes the document's comments ID of the property that denotes the document's template ID of the property that denotes the document's last author ID of the property that denotes the document's revision number ID of the property that denotes the document's edit time ID of the property that denotes the DateTime and time the document was last printed ID of the property that denotes the DateTime and time the document was Created. ID of the property that denotes the DateTime and time the document was saved ID of the property that denotes the number of pages in the document ID of the property that denotes the number of words in the document ID of the property that denotes the number of characters in the document ID of the property that denotes the document's thumbnail ID of the property that denotes the application that Created the document ID of the property that denotes whether Read/Write access To the document is allowed or whether is should be opened as Read-only. It can have the following values:
Value Description
0 No restriction
2 Read-only recommended
4 Read-only enforced
The entry is a dictionary. The entry denotes a code page. The entry is a string denoting the category the file belongs To, e.g. review, memo, etc. This is useful To Find documents of same type. TarGet format for power point presentation, e.g. 35mm, printer, video etc. Number of bytes. Number of lines. Number of paragraphs. Number of slides in a power point presentation. Number of slides with notes. Number of hidden slides. Number of multimedia clips, e.g. sound or video. This entry is Set To -1 when scaling of the thumbnail Is desired. Otherwise the thumbnail should be cropped. This entry denotes an internally used property. It is a vector of variants consisting of pairs of a string (VT_LPSTR) and a number (VT_I4). The string is a heading name, and the number tells how many document parts are under that heading. This entry Contains the names of document parts (word: names of the documents in the master document, excel: sheet names, power point: slide titles, binder: document names). This entry Contains the name of the project manager. This entry Contains the company name. If this entry is -1 the links are dirty and should be re-evaluated. The highest well-known property ID. Applications are free To use higher values for custom purposes. Contains the summary information property ID values and associated strings. See the overall HPSF documentation for details! Contains the summary information property ID values and associated strings. See the overall HPSF documentation for details! Initializes a new instance of the class. initialCapacity The initial capacity as defined for {@link HashMap} The load factor as defined for {@link HashMap} Initializes a new instance of the class. The instance To be Created is backed by this map. Puts a ID string for an ID into the {@link PropertyIDMap}. The ID string. The id string. As specified by the {@link java.util.Map} interface, this method returns the previous value associated with the specified id Gets the ID string for an ID from the {@link PropertyIDMap}. The ID. The ID string associated with id Gets the Summary Information properties singleton Gets the Document Summary Information properties singleton. The Document Summary Information properties singleton. Factory class To Create instances of {@link SummaryInformation}, {@link DocumentSummaryInformation} and {@link PropertySet}. @author Rainer Klute <klute@rainer-klute.de> @since 2002-02-09 Creates the most specific {@link PropertySet} from an {@link InputStream}. This is preferrably a {@link DocumentSummaryInformation} or a {@link SummaryInformation}. If the specified {@link InputStream} does not contain a property Set stream, an exception is thrown and the {@link InputStream} is repositioned at its beginning. Contains the property set stream's data. The Created {@link PropertySet}. Creates a new summary information the new summary information. Creates a new document summary information. the new document summary information. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format. @author Drew Varner (Drew.Varner inOrAround sc.edu) @since 2002-04-29 OffSet in bytes where the Clipboard Format Tag starts in the byte[] returned by SummaryInformation#GetThumbnail() OffSet in bytes where the Clipboard Format starts in the byte[] returned by SummaryInformation#GetThumbnail() This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS OffSet in bytes where the Windows Metafile (WMF) image data starts in the byte[] returned by SummaryInformation#GetThumbnail() There is only WMF data at this point in the byte[] if the Clipboard Format Tag is CFTAG_WINDOWS and the Clipboard Format is CF_METAFILEPICT. Note: The byte[] that starts at OFFSet_WMFDATA and ends at GetThumbnail().Length - 1 forms a complete WMF image. It can be saved To disk with a .wmf file type and Read using a WMF-capable image viewer. Clipboard Format Tag - Windows clipboard format A DWORD indicating a built-in Windows clipboard format value Clipboard Format Tag - Macintosh clipboard format A DWORD indicating a Macintosh clipboard format value Clipboard Format Tag - Format ID A GUID containing a format identifier (FMTID). This is rarely used. Clipboard Format Tag - No Data A DWORD indicating No data. This is rarely used. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams. Note:This is not the same format used in regular WMF images. The clipboard version of this format has an extra clipboard-specific header. Clipboard Format - Device Independent Bitmap Clipboard Format - Enhanced Windows metafile format Clipboard Format - Bitmap see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp A byte[] To hold a thumbnail image in ( Variant#VT_CF VT_CF) format. Default Constructor. If you use it then one you'll have To Add the thumbnail byte[] from {@link SummaryInformation#GetThumbnail()} To do any useful manipulations, otherwise you'll Get a NullPointerException. Initializes a new instance of the class. The thumbnail data. Returns an int representing the Clipboard Format Will throw an exception if the Thumbnail's Clipboard Format Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}. Possible return values are:
  • {@link #CF_METAFILEPICT CF_METAFILEPICT}
  • {@link #CF_DIB CF_DIB}
  • {@link #CF_ENHMETAFILE CF_ENHMETAFILE}
  • {@link #CF_BITMAP CF_BITMAP}
 a flag indicating the Clipboard Format Returns the Thumbnail as a byte[] of WMF data if the Thumbnail's Clipboard Format Tag is {@link #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is {@link #CF_METAFILEPICT CF_METAFILEPICT} This byte[] is in the traditional WMF file, not the clipboard-specific version with special headers. See http://www.wvware.com/caolan/ora-wmf.html for more information on the WMF image format. @return A WMF image of the Thumbnail @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and CF_METAFILEPICT Gets or sets the thumbnail as a byte[] in {@link Variant#VT_CF VT_CF} format. The thumbnail value Returns an int representing the Clipboard Format Tag Possible return values are:
  • {@link #CFTAG_WINDOWS CFTAG_WINDOWS}
  • {@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}
  • {@link #CFTAG_FMTID CFTAG_FMTID}
  • {@link #CFTAG_NODATA CFTAG_NODATA}
 A flag indicating the Clipboard Format Tag Defines constants of general use. @author Rainer Klute klute@rainer-klute.de @since 2004-06-20 Codepage 037, a special case Codepage for SJIS Codepage for GBK, aka MS936 Codepage for MS949 Codepage for UTF-16 Codepage for UTF-16 big-endian Codepage for Windows 1250 Codepage for Windows 1251 Codepage for Windows 1252 Codepage for Windows 1253 Codepage for Windows 1254 Codepage for Windows 1255 Codepage for Windows 1256 Codepage for Windows 1257 Codepage for Windows 1258 Codepage for Johab Codepage for Macintosh Roman (Java: MacRoman) Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or cp943) Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5, MS950, or cp937) Codepage for Macintosh Korean (Java: unknown - use EUC_KR or cp949) Codepage for Macintosh Arabic (Java: MacArabic) Codepage for Macintosh Hebrew (Java: MacHebrew) Codepage for Macintosh Greek (Java: MacGreek) Codepage for Macintosh Cyrillic (Java: MacCyrillic) Codepage for Macintosh Chinese Simplified (Java: unknown - use EUC_CN, ISO2022_CN_GB, MS936 or cp935) Codepage for Macintosh Romanian (Java: MacRomania) Codepage for Macintosh Ukrainian (Java: MacUkraine) Codepage for Macintosh Thai (Java: MacThai) Codepage for Macintosh Central Europe (Latin-2) (Java: MacCentralEurope) Codepage for Macintosh Iceland (Java: MacIceland) Codepage for Macintosh Turkish (Java: MacTurkish) Codepage for Macintosh Croatian (Java: MacCroatian) Codepage for US-ASCII Codepage for KOI8-R Codepage for ISO-8859-1 Codepage for ISO-8859-2 Codepage for ISO-8859-3 Codepage for ISO-8859-4 Codepage for ISO-8859-5 Codepage for ISO-8859-6 Codepage for ISO-8859-7 Codepage for ISO-8859-8 Codepage for ISO-8859-9 Codepage for ISO-2022-JP Another codepage for ISO-2022-JP Yet another codepage for ISO-2022-JP Codepage for ISO-2022-KR Codepage for EUC-JP Codepage for EUC-KR Codepage for GB2312 Codepage for GB18030 Another codepage for US-ASCII Codepage for UTF-8 Codepage for Unicode This exception is thrown if a {@link MutablePropertySet} is To be written but does not have a formatID Set (see {@link MutableSection#SetFormatID(ClassID)} or {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}. @author Rainer Klute <klute@rainer-klute.de> @since 2002-09-03 Initializes a new instance of the class. Initializes a new instance of the class. The exception's message string Initializes a new instance of the class. This exception's underlying reason Initializes a new instance of the class. The exception's message string This exception's underlying reason Provides various static utility methods. @author Rainer Klute (klute@rainer-klute.de) @since 2002-02-09 Copies a part of a byte array into another byte array. The source byte array. OffSet in the source byte array. The number of bytes To Copy. The destination byte array. OffSet in the destination byte array. Concatenates the contents of several byte arrays into a single one. The byte arrays To be conCatened. A new byte array containing the conCatenated byte arrays. Copies bytes from a source byte array into a new byte array. Copy from this byte array. Start Copying here. Copy this many bytes. The new byte array. Its Length is number of copied bytes. The difference between the Windows epoch (1601-01-01 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in milliseconds: 11644473600000L. (Use your favorite spReadsheet program To verify the correctness of this value. By the way, did you notice that you can tell from the epochs which operating system is the modern one? :-)) Converts a Windows FILETIME into a {@link DateTime}. The Windows FILETIME structure holds a DateTime and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. This 64-bit value is split into the two double words stored in the structure. The higher double word of the FILETIME structure. The lower double word of the FILETIME structure. The Windows FILETIME as a {@link DateTime}. Converts a Windows FILETIME into a {@link DateTime}. The Windows FILETIME structure holds a DateTime and time associated with a file. The structure identifies a 64-bit integer specifying the number of 100-nanosecond intervals which have passed since January 1, 1601. The filetime To Convert. The Windows FILETIME as a {@link DateTime}. Converts a {@link DateTime} into a filetime. The DateTime To be Converted The filetime Compares To object arrays with regarding the objects' order. For example, [1, 2, 3] and [2, 1, 3] are equal. The first object array. The second object array. true if the object arrays are equal, false if they are not. Internals the equals. The c1. The c2. Pads a byte array with 0x00 bytes so that its Length is a multiple of 4. The byte array To pad. The padded byte array. Pads a character array with 0x0000 characters so that its Length is a multiple of 4. The character array To pad. The padded character array. Pads a string with 0x0000 characters so that its Length is a multiple of 4. The string To pad. The padded string as a character array. Convenience class representing a Summary Information stream in a Microsoft Office document. @author Rainer Klute <klute@rainer-klute.de> @see DocumentSummaryInformation @since 2002-02-09 The document name a summary information stream usually has in a POIFS filesystem. Initializes a new instance of the class. A property Set which should be Created from a summary information stream. Removes the title. Removes the subject. Removes the author. Removes the keywords. Removes the comments. Removes the template. Removes the last author. Removes the rev number. Removes the edit time. Removes the last printed. Removes the create date time. Removes the last save date time. Removes the page count. Removes the word count. Removes the char count. Removes the thumbnail. Removes the name of the application. Removes the security code. Gets or sets the title. The title. Gets or sets the subject. The subject. Gets or sets the author. The author. Gets or sets the keywords. The keywords. Gets or sets the comments. The comments. Gets or sets the template. The template. Gets or sets the last author. The last author. Gets or sets the rev number. The rev number. Returns the Total time spent in editing the document (or 0). The Total time spent in editing the document or 0 if the {@link SummaryInformation} does not contain this information. Gets or sets the last printed time The last printed time Returns the last printed time (or null). Gets or sets the create date time. The create date time. Gets or sets the last save date time. The last save date time. Gets or sets the page count or 0 if the {@link SummaryInformation} does not contain a page count. The page count or 0 if the {@link SummaryInformation} does not contain a page count. Gets or sets the word count or 0 if the {@link SummaryInformation} does not contain a word count. The word count. Gets or sets the character count or 0 if the {@link SummaryInformation} does not contain a char count. The character count. Gets or sets the thumbnail (or null) when this method is implemented. Please note that the return type is likely To Change! Hint To developers: Drew Varner <Drew.Varner -at- sc.edu> said that this is an image in WMF or Clipboard (BMP?) format. However, we won't do any conversion into any image type but instead just return a byte array. The thumbnail. Gets or sets the name of the application. The name of the application. Gets or sets a security code which is one of the following values:
  • 0 if the {@link SummaryInformation} does not contain a security field or if there is no security on the document. Use {@link PropertySet#wasNull()} To distinguish between the two cases!
  • 1 if the document is password protected
  • 2 if the document is Read-only recommended
  • 4 if the document is Read-only enforced
  • 8 if the document is locked for annotations
 The security code Class for writing little-endian data and more. @author Rainer Klute <klute@rainer-klute.de> @since 2003-02-20 Writes a two-byte value (short) To an output stream. The stream To Write To.. The number of bytes that have been written. Writes a four-byte value To an output stream. @param out The stream To Write To. @param n The value To Write. @exception IOException if an I/O error occurs @return The number of bytes written To the output stream. Writes a four-byte value To an output stream. @param out The stream To Write To. @param n The value To Write. @exception IOException if an I/O error occurs @return The number of bytes written To the output stream. Writes a eight-byte value To an output stream. @param out The stream To Write To. @param n The value To Write. @exception IOException if an I/O error occurs @return The number of bytes written To the output stream. Writes an unsigned two-byte value To an output stream. @param out The stream To Write To @param n The value To Write @exception IOException if an I/O error occurs Writes an unsigned four-byte value To an output stream. @param out The stream To Write To. @param n The value To Write. @return The number of bytes that have been written To the output stream. @exception IOException if an I/O error occurs Writes a 16-byte {@link ClassID} To an output stream. @param out The stream To Write To @param n The value To Write @return The number of bytes written @exception IOException if an I/O error occurs Writes an array of {@link Property} instances To an output stream according To the Horrible Property Format. @param out The stream To Write To @param properties The array To Write To the stream @param codepage The codepage number To use for writing strings @exception IOException if an I/O error occurs @throws UnsupportedVariantTypeException if HPSF does not support some variant type. Writes a double value value To an output stream. @param out The stream To Write To. @param n The value To Write. @exception IOException if an I/O error occurs @return The number of bytes written To the output stream.