|
| |
|
| java.lang.Object
 org.apache.poi.hpsf.PropertySet
All known Subclasses: org.apache.poi.hpsf.MutablePropertySet,
| Constructor Summary | |
| protected | PropertySet()
| | public | PropertySet(InputStream stream)
Creates a
PropertySet instance from an
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. | | public | PropertySet(byte[] stream, int offset, int length)
Creates a
PropertySet instance from a byte array
that represents a stream in the Horrible Property Set
Format.
Parameters:
stream - The byte array holding the stream data.
Parameters:
offset - The offset in stream where the streamdata begin. | | public | PropertySet(byte[] stream)
Creates a
PropertySet instance from a byte array
that represents a stream in the Horrible Property Set
Format.
Parameters:
stream - The byte array holding the stream data. |
| BYTE_ORDER_ASSERTION | | final static byte[] BYTE_ORDER_ASSERTION(Code) | | The "byteOrder" field must equal this value.
|
| FORMAT_ASSERTION | | final static byte[] FORMAT_ASSERTION(Code) | | The "format" field must equal this value.
|
| OS_MACINTOSH | | final public static int OS_MACINTOSH(Code) | | If the OS version field holds this value the property set stream was
created on a Macintosh system.
|
| OS_WIN16 | | final public static int OS_WIN16(Code) | | If the OS version field holds this value the property set stream was
created on a 16-bit Windows system.
|
| OS_WIN32 | | final public static int OS_WIN32(Code) | | If the OS version field holds this value the property set stream was
created on a 32-bit Windows system.
|
| byteOrder | | protected int byteOrder(Code) | | Specifies this
PropertySet 's byte order. See the
HPFS documentation for details!
|
| classID | | protected ClassID classID(Code) | | Specifies this
PropertySet 's "classID" field. See
the HPFS documentation for details!
|
| format | | protected int format(Code) | | Specifies this
PropertySet 's format. See the HPFS
documentation for details!
|
| osVersion | | protected int osVersion(Code) | | Specifies the version of the operating system that created
this
PropertySet . See the HPFS documentation for
details!
|
| PropertySet | | protected PropertySet()(Code) | | Creates an empty (uninitialized)
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.
|
| PropertySet | | public PropertySet(byte[] stream, int offset, int length) throws NoPropertySetStreamException, UnsupportedEncodingException(Code) | | Creates a
PropertySet instance from a byte array
that represents a stream in the Horrible Property Set
Format.
Parameters:
stream - The byte array holding the stream data.
Parameters:
offset - The offset in stream where the streamdata begin. If the stream data begin with the first byte in thearray, the offset is 0.
Parameters:
length - The length of the stream data.
throws:
NoPropertySetStreamException - if the byte array is not aproperty set stream.
exception:
UnsupportedEncodingException - if the codepage is not supported. |
| equals | | public boolean equals(Object o)(Code) | | Returns true if the PropertySet is equal
to the specified parameter, else false.
Parameters:
o - the object to compare this PropertySet with true if the objects are equal, falseif not |
| getByteOrder | | public int getByteOrder()(Code) | | Returns the property set stream's low-level "byte order"
field. It is always 0xFFFE .
The property set stream's low-level "byte order" field. |
| getClassID | | public ClassID getClassID()(Code) | | Returns the property set stream's low-level "class ID"
field.
The property set stream's low-level "class ID" field. |
| getFormat | | public int getFormat()(Code) | | Returns the property set stream's low-level "format"
field. It is always 0x0000 .
The property set stream's low-level "format" field. |
| getOSVersion | | public int getOSVersion()(Code) | | Returns the property set stream's low-level "OS version"
field.
The property set stream's low-level "OS version" field. |
| getPropertyBooleanValue | | protected boolean getPropertyBooleanValue(int id) throws NoSingleSectionException(Code) | | Convenience method returning the value of a boolean property
with the specified ID. If the property is not available,
false is returned. A subsequent call to
PropertySet.wasNull will return true to let the caller
distinguish that case from a real property value of
false.
Parameters:
id - The property ID The property value
throws:
NoSingleSectionException - if the PropertySet hasmore or less than one Section. |
| getPropertyIntValue | | protected int getPropertyIntValue(int id) throws NoSingleSectionException(Code) | | 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
PropertySet.wasNull will return true to let the caller distinguish
that case from a real property value of 0.
Parameters:
id - The property ID The propertyIntValue value
throws:
NoSingleSectionException - if the PropertySet hasmore or less than one Section. |
| getSectionCount | | public int getSectionCount()(Code) | | Returns the number of
Section s in the property
set.
The number of Sections in the property set. |
| getSingleSection | | public Section getSingleSection()(Code) | | If the
PropertySet has only a single section this
method returns it.
The singleSection value |
| isDocumentSummaryInformation | | public boolean isDocumentSummaryInformation()(Code) | | Checks whether this
PropertySet is a Document
Summary Information.
true if this PropertySetrepresents a Document Summary Information, else false. |
| isPropertySetStream | | public static boolean isPropertySetStream(byte[] src, int offset, int length)(Code) | | Checks whether a byte array is in the Horrible Property Set
Format.
Parameters:
src - The byte array to check.
Parameters:
offset - The offset in the byte array.
Parameters:
length - The significant number of bytes in the bytearray. Only this number of bytes will be checked. true if the byte array is a property setstream, false if not. |
| isSummaryInformation | | public boolean isSummaryInformation()(Code) | | Checks whether this
PropertySet represents a Summary
Information.
true if this PropertySetrepresents a Summary Information, else false. |
|
|
|