Package loci.poi.hpsf

Class MutableProperty

java.lang.Object
loci.poi.hpsf.Property
loci.poi.hpsf.MutableProperty
Direct Known Subclasses:
CustomProperty

public class MutableProperty extends Property

Adds writing capability to the Property class.

Please be aware that this class' functionality will be merged into the Property class at a later time, so the API will change.

Since:
2003-08-03
Version:
$Id: MutableProperty.java 489730 2006-12-22 19:18:16Z bayard $
Author:
Rainer Klute <klute@rainer-klute.de>
  • Constructor Details

    • MutableProperty

      public MutableProperty()

      Creates an empty property. It must be filled using the set method to be usable.

    • MutableProperty

      public MutableProperty(Property p)

      Creates a MutableProperty as a copy of an existing Property.

      Parameters:
      p - The property to copy.
  • Method Details

    • setID

      public void setID(long id)

      Sets the property's ID.

      Parameters:
      id - the ID
    • setType

      public void setType(long type)

      Sets the property's type.

      Parameters:
      type - the property's type
    • setValue

      public void setValue(Object value)

      Sets the property's value.

      Parameters:
      value - the property's value
    • write

      public int write(OutputStream out, int codepage) throws IOException, WritingNotSupportedException

      Writes the property to an output stream.

      Parameters:
      out - The output stream to write to.
      codepage - The codepage to use for writing non-wide strings
      Returns:
      the number of bytes written to the stream
      Throws:
      IOException - if an I/O error occurs
      WritingNotSupportedException - if a variant type is to be written that is not yet supported