| java.lang.Object
 org.apache.poi.hpsf.Property
All known Subclasses: org.apache.poi.hpsf.MutableProperty,
| Property | | public class Property (Code) | | A property in a
Section of a
PropertySet .
The property's ID gives the property a meaning
in the context of its
Section . Each
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
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
Variant.VT_I4 denotes a four-byte integer
value,
Variant.VT_FILETIME some date and time (of a
file).
Please note that not all
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 author:
href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de>
author:
Drew Varner (Drew.Varner InAndAround sc.edu)
See Also: Section
See Also: Variant
version:
$Id: Property.java 489730 2006-12-22 19:18:16Z bayard $
since:
2002-02-09 |
| Constructor Summary | |
| public | Property(long id, long type, Object value)
Creates a property.
Parameters:
id - the property's ID.
Parameters:
type - the property's type, see Variant.
Parameters:
value - the property's value. | | public | Property(long id, byte[] src, long offset, int length, int codepage)
Creates a
Property instance by reading its bytes
from the property set stream.
Parameters:
id - The property's ID.
Parameters:
src - The bytes the property set stream consists of.
Parameters:
offset - The property's type/value pair's offset in thesection.
Parameters:
length - The property's type/value pair's length in bytes.
Parameters:
codepage - The section's and thus the property'scodepage. | | protected | Property()
Creates an empty property. |
| Method Summary | |
| public boolean | equals(Object o)
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. | | public long | getID()
| | protected int | getSize()
Returns the property's size in bytes. | | public long | getType()
| | public Object | getValue()
| | public int | hashCode()
| | protected Map | readDictionary(byte[] src, long offset, int length, int codepage)
Reads a dictionary.
Parameters:
src - The byte array containing the bytes making out the dictionary.
Parameters:
offset - At this offset within src the dictionarystarts.
Parameters:
length - The dictionary contains at most this many bytes.
Parameters:
codepage - The codepage of the string values. | | public String | toString()
|
| id | | protected long id(Code) | | The property's ID.
|
| type | | protected long type(Code) | | The property's type.
|
| Property | | public Property(long id, long type, Object value)(Code) | | Creates a property.
Parameters:
id - the property's ID.
Parameters:
type - the property's type, see Variant.
Parameters:
value - the property's value. Only certain types are allowed, see Variant. |
| Property | | public Property(long id, byte[] src, long offset, int length, int codepage) throws UnsupportedEncodingException(Code) | | Creates a
Property instance by reading its bytes
from the property set stream.
Parameters:
id - The property's ID.
Parameters:
src - The bytes the property set stream consists of.
Parameters:
offset - The property's type/value pair's offset in thesection.
Parameters:
length - The property's type/value pair's length in bytes.
Parameters:
codepage - The section's and thus the property'scodepage. It is needed only when reading string values.
exception:
UnsupportedEncodingException - if the specified codepage is notsupported. |
| Property | | protected Property()(Code) | | Creates an empty property. It must be filled using the set method to
be usable.
|
| equals | | public boolean equals(Object o)(Code) | | 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;
See Also: Object.equals(java.lang.Object) |
| getID | | public long getID()(Code) | | Returns the property's ID.
The ID value |
| getType | | public long getType()(Code) | | Returns the property's type.
The type value |
| getValue | | public Object getValue()(Code) | | Returns the property's value.
The property's value |
| readDictionary | | protected Map readDictionary(byte[] src, long offset, int length, int codepage) throws UnsupportedEncodingException(Code) | | Reads a dictionary.
Parameters:
src - The byte array containing the bytes making out the dictionary.
Parameters:
offset - At this offset within src the dictionarystarts.
Parameters:
length - The dictionary contains at most this many bytes.
Parameters:
codepage - The codepage of the string values. The dictonary
throws:
UnsupportedEncodingException - if the dictionary's codepage is not(yet) supported. |
|
|