public class Property
extends java.lang.Object
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.
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_CODEPAGE
Default codepage for
CodePageStrings |
Constructor and Description |
---|
Property()
Creates an empty property.
|
Property(long id,
byte[] src,
long offset,
int length,
int codepage)
Creates a
Property instance by reading its bytes
from the property set stream. |
Property(long id,
LittleEndianByteArrayInputStream leis,
int length,
int codepage)
Creates a
Property instance by reading its bytes
from the property set stream. |
Property(long id,
long type,
java.lang.Object value)
Creates a property.
|
Property(Property p)
Creates a
Property as a copy of an existing Property . |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o)
Compares two properties.
|
long |
getID()
Returns the property's ID.
|
protected int |
getSize(int property)
Returns the property's size in bytes.
|
long |
getType()
Returns the property's type.
|
java.lang.Object |
getValue()
Returns the property's value.
|
int |
hashCode() |
void |
setID(long id)
Sets the property's ID.
|
void |
setType(long type)
Sets the property's type.
|
void |
setValue(java.lang.Object value)
Sets the property's value.
|
java.lang.String |
toString() |
java.lang.String |
toString(int codepage,
PropertyIDMap idMap) |
int |
write(java.io.OutputStream out,
int codepage)
Writes the property to an output stream.
|
public static final int DEFAULT_CODEPAGE
CodePageStrings
public Property()
public Property(Property p)
Property
as a copy of an existing Property
.p
- The property to copy.public Property(long id, long type, java.lang.Object value)
public Property(long id, byte[] src, long offset, int length, int codepage) throws java.io.UnsupportedEncodingException
Property
instance by reading its bytes
from the property set stream.id
- The property's ID.src
- The bytes the property set stream consists of.offset
- The property's type/value pair's offset in the
section.length
- The property's type/value pair's length in bytes.codepage
- The section's and thus the property's
codepage. It is needed only when reading string values.java.io.UnsupportedEncodingException
- if the specified codepage is not
supported.public Property(long id, LittleEndianByteArrayInputStream leis, int length, int codepage) throws java.io.UnsupportedEncodingException
Property
instance by reading its bytes
from the property set stream.id
- The property's ID.leis
- The bytes the property set stream consists of.length
- The property's type/value pair's length in bytes.codepage
- The section's and thus the property's
codepage. It is needed only when reading string values.java.io.UnsupportedEncodingException
- if the specified codepage is not
supported.public long getID()
public void setID(long id)
id
- the IDpublic long getType()
public void setType(long type)
type
- the property's typepublic java.lang.Object getValue()
public void setValue(java.lang.Object value)
value
- the property's valueprotected int getSize(int property) throws WritingNotSupportedException
property
- The integer property to checkWritingNotSupportedException
- if HPSF does not yet support the
property's variant type.public boolean equals(java.lang.Object o)
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;
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public java.lang.String toString(int codepage, PropertyIDMap idMap)
public int write(java.io.OutputStream out, int codepage) throws java.io.IOException, WritingNotSupportedException
out
- The output stream to write to.codepage
- The codepage to use for writing non-wide stringsjava.io.IOException
- if an I/O error occursWritingNotSupportedException
- if a variant type is to be
written that is not yet supportedCopyright 2020 The Apache Software Foundation or its licensors, as applicable.