diff options
Diffstat (limited to 'src/java/org/apache/poi/hpsf/SpecialPropertySet.java')
| -rw-r--r-- | src/java/org/apache/poi/hpsf/SpecialPropertySet.java | 397 |
1 files changed, 12 insertions, 385 deletions
diff --git a/src/java/org/apache/poi/hpsf/SpecialPropertySet.java b/src/java/org/apache/poi/hpsf/SpecialPropertySet.java index aa8f8051d2..843d681ebc 100644 --- a/src/java/org/apache/poi/hpsf/SpecialPropertySet.java +++ b/src/java/org/apache/poi/hpsf/SpecialPropertySet.java @@ -17,397 +17,24 @@ package org.apache.poi.hpsf; -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.nio.charset.Charset; -import java.util.List; - -import org.apache.poi.hpsf.wellknown.PropertyIDMap; -import org.apache.poi.poifs.filesystem.DirectoryEntry; -import org.apache.poi.util.LittleEndian; +import org.apache.poi.util.Removal; /** - * <p>Abstract superclass for the convenience classes {@link - * SummaryInformation} and {@link DocumentSummaryInformation}.</p> + * Interface for the convenience classes {@link SummaryInformation} + * and {@link DocumentSummaryInformation}.<p> * - * <p>The motivation behind this class is quite nasty if you look - * behind the scenes, but it serves the application programmer well by - * providing him with the easy-to-use {@link SummaryInformation} and - * {@link DocumentSummaryInformation} classes. When parsing the data a - * property set stream consists of (possibly coming from an {@link - * java.io.InputStream}) we want to read and process each byte only - * once. Since we don't know in advance which kind of property set we - * have, we can expect only the most general {@link - * PropertySet}. Creating a special subclass should be as easy as - * calling the special subclass' constructor and pass the general - * {@link PropertySet} in. To make things easy internally, the special - * class just holds a reference to the general {@link PropertySet} and - * delegates all method calls to it.</p> + * This used to be an abstract class to support late loading + * of the SummaryInformation classes, as their concrete instance can + * only be determined after the PropertySet has been loaded. * - * <p>A cleaner implementation would have been like this: The {@link - * PropertySetFactory} parses the stream data into some internal - * object first. Then it finds out whether the stream is a {@link - * SummaryInformation}, a {@link DocumentSummaryInformation} or a - * general {@link PropertySet}. However, the current implementation - * went the other way round historically: the convenience classes came - * only late to my mind.</p> + * @deprecated POI 3.16 - use PropertySet as base class instead */ -public abstract class SpecialPropertySet extends MutablePropertySet -{ - /** - * The id to name mapping of the properties in this set. - * - * @return the id to name mapping of the properties in this set - */ - public abstract PropertyIDMap getPropertySetIDMap(); - - /** - * <p>The "real" property set <code>SpecialPropertySet</code> - * delegates to.</p> - */ - private final MutablePropertySet delegate; - - - - /** - * <p>Creates a <code>SpecialPropertySet</code>. - * - * @param ps The property set to be encapsulated by the - * <code>SpecialPropertySet</code> - */ - public SpecialPropertySet(final PropertySet ps) - { - delegate = new MutablePropertySet(ps); - } - - - - /** - * <p>Creates a <code>SpecialPropertySet</code>. - * - * @param ps The mutable property set to be encapsulated by the - * <code>SpecialPropertySet</code> - */ - public SpecialPropertySet(final MutablePropertySet ps) - { - delegate = ps; - } - - - - /** - * @see PropertySet#getByteOrder - */ - @Override - public int getByteOrder() - { - return delegate.getByteOrder(); - } - - - - /** - * @see PropertySet#getFormat - */ - @Override - public int getFormat() - { - return delegate.getFormat(); - } - - - - /** - * @see PropertySet#getOSVersion - */ - @Override - public int getOSVersion() - { - return delegate.getOSVersion(); - } - - - - /** - * @see PropertySet#getClassID - */ - @Override - public ClassID getClassID() - { - return delegate.getClassID(); - } - - - - /** - * @see PropertySet#getSectionCount - */ - @Override - public int getSectionCount() - { - return delegate.getSectionCount(); - } - - - - /** - * @see PropertySet#getSections - */ - @Override - public List<Section> getSections() - { - return delegate.getSections(); - } - - - - /** - * @see PropertySet#isSummaryInformation - */ - @Override - public boolean isSummaryInformation() - { - return delegate.isSummaryInformation(); - } - - - - /** - * @see PropertySet#isDocumentSummaryInformation - */ - @Override - public boolean isDocumentSummaryInformation() - { - return delegate.isDocumentSummaryInformation(); - } - - - - /** - * @see PropertySet#getSingleSection - */ - @Override - public Section getFirstSection() - { - return delegate.getFirstSection(); - } - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#addSection(org.apache.poi.hpsf.Section) - */ - @Override - public void addSection(final Section section) - { - delegate.addSection(section); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#clearSections() - */ - @Override - public void clearSections() - { - delegate.clearSections(); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#setByteOrder(int) - */ - @Override - public void setByteOrder(final int byteOrder) - { - delegate.setByteOrder(byteOrder); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#setClassID(org.apache.poi.hpsf.ClassID) - */ - @Override - public void setClassID(final ClassID classID) - { - delegate.setClassID(classID); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#setFormat(int) - */ - @Override - public void setFormat(final int format) - { - delegate.setFormat(format); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#setOSVersion(int) - */ - @Override - public void setOSVersion(final int osVersion) - { - delegate.setOSVersion(osVersion); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#toInputStream() - */ - @Override - public InputStream toInputStream() throws IOException, WritingNotSupportedException - { - return delegate.toInputStream(); - } - - - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#write(org.apache.poi.poifs.filesystem.DirectoryEntry, java.lang.String) - */ - @Override - public void write(final DirectoryEntry dir, final String name) throws WritingNotSupportedException, IOException - { - delegate.write(dir, name); - } - - /** - * @see org.apache.poi.hpsf.MutablePropertySet#write(java.io.OutputStream) - */ - @Override - public void write(final OutputStream out) throws WritingNotSupportedException, IOException - { - delegate.write(out); - } - - /** - * @see org.apache.poi.hpsf.PropertySet#equals(java.lang.Object) - */ - @Override - public boolean equals(final Object o) - { - return delegate.equals(o); +@Removal(version="3.18") +public class SpecialPropertySet extends MutablePropertySet { + public SpecialPropertySet() { } - /** - * @see org.apache.poi.hpsf.PropertySet#getProperties() - */ - @Override - public Property[] getProperties() throws NoSingleSectionException - { - return delegate.getProperties(); + public SpecialPropertySet(final PropertySet ps) throws UnexpectedPropertySetTypeException { + super(ps); } - - /** - * @see org.apache.poi.hpsf.PropertySet#getProperty(int) - */ - @Override - protected Object getProperty(final int id) throws NoSingleSectionException - { - return delegate.getProperty(id); - } - - - - /** - * @see org.apache.poi.hpsf.PropertySet#getPropertyBooleanValue(int) - */ - @Override - protected boolean getPropertyBooleanValue(final int id) throws NoSingleSectionException - { - return delegate.getPropertyBooleanValue(id); - } - - - - /** - * @see org.apache.poi.hpsf.PropertySet#getPropertyIntValue(int) - */ - @Override - protected int getPropertyIntValue(final int id) throws NoSingleSectionException - { - return delegate.getPropertyIntValue(id); - } - - - - /** - * Fetches the property with the given ID, then does its - * best to return it as a String - * - * @param propertyId the property id - * - * @return The property as a String, or null if unavailable - */ - protected String getPropertyStringValue(final int propertyId) { - Object propertyValue = getProperty(propertyId); - return getPropertyStringValue(propertyValue); - } - protected static String getPropertyStringValue(final Object propertyValue) { - // Normal cases - if (propertyValue == null) return null; - if (propertyValue instanceof String) return (String)propertyValue; - - // Do our best with some edge cases - if (propertyValue instanceof byte[]) { - byte[] b = (byte[])propertyValue; - if (b.length == 0) { - return ""; - } - if (b.length == 1) { - return Byte.toString(b[0]); - } - if (b.length == 2) { - return Integer.toString( LittleEndian.getUShort(b) ); - } - if (b.length == 4) { - return Long.toString( LittleEndian.getUInt(b) ); - } - // Maybe it's a string? who knows! - return new String(b, Charset.forName("ASCII")); - } - return propertyValue.toString(); - } - - - /** - * @see org.apache.poi.hpsf.PropertySet#hashCode() - */ - @Override - public int hashCode() - { - return delegate.hashCode(); - } - - - - /** - * @see org.apache.poi.hpsf.PropertySet#toString() - */ - @Override - public String toString() - { - return delegate.toString(); - } - - - - /** - * @see org.apache.poi.hpsf.PropertySet#wasNull() - */ - @Override - public boolean wasNull() throws NoSingleSectionException - { - return delegate.wasNull(); - } - } |