|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hpsf.Section
org.apache.poi.hpsf.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.
Field Summary |
Fields inherited from class org.apache.poi.hpsf.Section |
dictionary, formatID, offset, properties, size |
Constructor Summary | |
MutableSection()
Creates an empty mutable section. |
|
MutableSection(Section s)
Constructs a MutableSection by doing a deep copy of an
existing Section . |
Method Summary | |
Property[] |
getProperties()
Gets this section's properties. |
java.lang.Object |
getProperty(long id)
Gets a property. |
int |
getPropertyCount()
Overwrites the super class' method to cope with a redundancy: the property count is maintained in a separate member variable, but shouldn't. |
int |
getSize()
Returns the section's size. |
void |
removeProperty(long id)
Removes a property. |
void |
setDictionary(java.util.Map dictionary)
Sets the section's dictionary. |
void |
setFormatID(byte[] formatID)
Sets the section's format ID. |
void |
setFormatID(ClassID formatID)
Sets the section's format ID. |
void |
setProperties(Property[] properties)
Sets this section's properties. |
void |
setProperty(int id,
long variantType,
java.lang.Object value)
Sets the value and the variant type of the property with the specified ID. |
void |
setProperty(int id,
java.lang.String value)
Sets the value of the property with the specified ID. |
void |
setProperty(Property p)
Sets a property. |
protected void |
setPropertyBooleanValue(int id,
boolean value)
Sets the value of the boolean property with the specified ID. |
int |
write(java.io.OutputStream out)
Writes this section into an output stream. |
Methods inherited from class org.apache.poi.hpsf.Section |
equals, getCodepage, getDictionary, getFormatID, getOffset, getPIDString, getPropertyBooleanValue, getPropertyIntValue, hashCode, toString, wasNull |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public MutableSection()
Creates an empty mutable section.
public MutableSection(Section s)
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
.
s
- The section set to copyMethod Detail |
public void setFormatID(ClassID formatID)
Sets the section's format ID.
formatID
- The section's format IDsetFormatID(byte[])
,
Section.getFormatID()
public void setFormatID(byte[] formatID)
Sets the section's format ID.
formatID
- The section's format ID as a byte array. It components
are in big-endian format.setFormatID(ClassID)
,
Section.getFormatID()
public void setProperties(Property[] properties)
Sets this section's properties. Any former values are overwritten.
properties
- This section's new properties.public void setProperty(int id, java.lang.String value)
Sets the value 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.
id
- The property's IDvalue
- The property's value. It will be written as a Unicode
string.setProperty(int, long, Object)
,
getProperty(long)
public void setProperty(int id, long variantType, java.lang.Object 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.
id
- The property's ID.variantType
- The property's variant type.value
- The property's value.setProperty(int, String)
,
getProperty(long)
,
Variant
public void setProperty(Property p)
Sets a property. If a property with the same ID is not yet present in the section, the property will be added to the section. If there is already a property with the same ID present in the section, it will be overwritten.
p
- The property to be added to the sectionsetProperty(int, long, Object)
,
setProperty(int, String)
,
getProperty(long)
,
Variant
public void removeProperty(long id)
Removes a property.
id
- The ID of the property to be removedprotected void setPropertyBooleanValue(int id, boolean value)
Sets the value of the boolean property with the specified ID.
id
- The property's IDvalue
- The property's valuesetProperty(int, long, Object)
,
getProperty(long)
,
Variant
public int getSize()
Returns the section's size.
getSize
in class Section
public int write(java.io.OutputStream out) throws WritingNotSupportedException, java.io.IOException
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.
out
- The stream to write into.
java.io.IOException
- if an I/O error occurs
WritingNotSupportedException
- if HPSF does not yet support
writing a property's variant type.public int getPropertyCount()
Overwrites the super class' method to cope with a redundancy: the property count is maintained in a separate member variable, but shouldn't.
getPropertyCount
in class Section
public Property[] getProperties()
Gets this section's properties.
getProperties
in class Section
public java.lang.Object getProperty(long id)
Gets a property.
getProperty
in class Section
id
- The ID of the property to get
null
if there is no such propertypublic void setDictionary(java.util.Map dictionary) throws IllegalPropertySetDataException
Sets the section's dictionary. All keys in the dictionary must be
Long
instances, all values must be
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.
dictionary
- The dictionary
IllegalPropertySetDataException
- if the dictionary's key and
value types are not correct.Section.getDictionary()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |