Javadoc, formatting and style improvements
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353280 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute
parent
ed6a27c2be
commit
7e303c76c2
17
.classpath
17
.classpath
@ -1,14 +1,13 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<classpath>
|
||||
<classpathentry kind="src" path="src/testcases"/>
|
||||
<classpathentry kind="src" path="src/java"/>
|
||||
<classpathentry excluding="**/CVS/*" kind="src" path="src/testcases"/>
|
||||
<classpathentry excluding="**/CVS/*" kind="src" path="src/java"/>
|
||||
<classpathentry excluding="**/CVS/*" kind="src" path="src/contrib/src"/>
|
||||
<classpathentry kind="var" path="JRE_LIB" sourcepath="JRE_SRC"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/ant.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/junit.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/commons-logging.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/xerces-2.3.0.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/xercesImpl.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jboss/test/apache-ant-1.5.3-1/lib/xml-apis.jar"/>
|
||||
<classpathentry kind="lib" path="/Users/andrewoliver/projects/jakarta/poimerge/jakarta-poi/lib/xalan-2.2.0.jar"/>
|
||||
<classpathentry kind="lib" path="lib/commons-logging-1.0.1.jar"/>
|
||||
<classpathentry kind="lib" path="lib/log4j-1.2.8.jar"/>
|
||||
<classpathentry kind="lib" path="src/contrib/lib/commons-lang-1.0-b1.jar"/>
|
||||
<classpathentry kind="lib" path="src/contrib/lib/commons-beanutils-1.6.jar"/>
|
||||
<classpathentry kind="lib" path="lib/junit-3.8.1.jar"/>
|
||||
<classpathentry kind="output" path="build"/>
|
||||
</classpath>
|
||||
|
||||
8
.project
8
.project
@ -1,10 +1,15 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<projectDescription>
|
||||
<name>POI</name>
|
||||
<name>POI-Head-1</name>
|
||||
<comment></comment>
|
||||
<projects>
|
||||
</projects>
|
||||
<buildSpec>
|
||||
<buildCommand>
|
||||
<name>com.atlassw.tools.eclipse.checkstyle.CheckstyleBuilder</name>
|
||||
<arguments>
|
||||
</arguments>
|
||||
</buildCommand>
|
||||
<buildCommand>
|
||||
<name>org.eclipse.jdt.core.javabuilder</name>
|
||||
<arguments>
|
||||
@ -13,5 +18,6 @@
|
||||
</buildSpec>
|
||||
<natures>
|
||||
<nature>org.eclipse.jdt.core.javanature</nature>
|
||||
<nature>com.atlassw.tools.eclipse.checkstyle.CheckstyleNature</nature>
|
||||
</natures>
|
||||
</projectDescription>
|
||||
|
||||
@ -55,9 +55,6 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.io.*;
|
||||
import org.apache.poi.util.LittleEndian;
|
||||
|
||||
/**
|
||||
* <p>Represents a class ID (16 bytes). Unlike other little-endian
|
||||
* type the {@link ClassID} is not just 16 bytes stored in the wrong
|
||||
@ -105,8 +102,14 @@ public class ClassID
|
||||
|
||||
|
||||
|
||||
public final static int LENGTH = 16;
|
||||
/** <p>The number of bytes occupied by this object in the byte
|
||||
* stream.</p> */
|
||||
public static final int LENGTH = 16;
|
||||
|
||||
/**
|
||||
* @return The number of bytes occupied by this object in the byte
|
||||
* stream.
|
||||
*/
|
||||
public int length()
|
||||
{
|
||||
return LENGTH;
|
||||
@ -117,6 +120,8 @@ public class ClassID
|
||||
/**
|
||||
* <p>Gets the bytes making out the class ID. They are returned in
|
||||
* correct order, i.e. big-endian.</p>
|
||||
*
|
||||
* @return the bytes making out the class ID.
|
||||
*/
|
||||
public byte[] getBytes()
|
||||
{
|
||||
@ -170,13 +175,17 @@ public class ClassID
|
||||
*
|
||||
* @param offset The offset within the <var>dst</var> byte array.
|
||||
*
|
||||
* @throws ArrayIndexOutOfBoundsException if there is not enough
|
||||
* room for the class ID in the byte array. There must be at least
|
||||
* 16 bytes in the byte array after the <var>offset</var>
|
||||
* position.
|
||||
* @exception ArrayStoreException if there is not enough room for the class
|
||||
* ID 16 bytes in the byte array after the <var>offset</var> position.
|
||||
*/
|
||||
public void write(final byte[] dst, final int offset)
|
||||
throws ArrayStoreException
|
||||
{
|
||||
/* Check array size: */
|
||||
if (dst.length < 16)
|
||||
throw new ArrayStoreException
|
||||
("Destination byte[] must have room for at least 16 bytes, " +
|
||||
"but has a length of only " + dst.length + ".");
|
||||
/* Write double word. */
|
||||
dst[0 + offset] = bytes[3];
|
||||
dst[1 + offset] = bytes[2];
|
||||
|
||||
@ -54,9 +54,7 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.io.*;
|
||||
import java.util.*;
|
||||
import org.apache.poi.hpsf.wellknown.*;
|
||||
import org.apache.poi.hpsf.wellknown.PropertyIDMap;
|
||||
|
||||
/**
|
||||
* <p>Convenience class representing a DocumentSummary Information stream in a
|
||||
|
||||
@ -66,12 +66,16 @@ package org.apache.poi.hpsf;
|
||||
public class HPSFException extends Exception
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>The underlying reason for this exception - may be
|
||||
* <code>null</code>.</p>
|
||||
* */
|
||||
private Throwable reason;
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates a new {@link HPSFException}.</p>
|
||||
* <p>Creates an {@link HPSFException}.</p>
|
||||
*/
|
||||
public HPSFException()
|
||||
{
|
||||
@ -81,8 +85,7 @@ public class HPSFException extends Exception
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates a new {@link HPSFException} with a message
|
||||
* string.</p>
|
||||
* <p>Creates an {@link HPSFException} with a message string.</p>
|
||||
*
|
||||
* @param msg The message string.
|
||||
*/
|
||||
@ -108,8 +111,8 @@ public class HPSFException extends Exception
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates a new {@link HPSFException} with a message string
|
||||
* and a reason.</p>
|
||||
* <p>Creates an {@link HPSFException} with a message string and a
|
||||
* reason.</p>
|
||||
*
|
||||
* @param msg The message string.
|
||||
* @param reason The reason, i.e. a throwable that indirectly
|
||||
|
||||
@ -66,6 +66,8 @@ package org.apache.poi.hpsf;
|
||||
public class HPSFRuntimeException extends RuntimeException
|
||||
{
|
||||
|
||||
/** <p>The underlying reason for this exception - may be
|
||||
* <code>null</code>.</p> */
|
||||
private Throwable reason;
|
||||
|
||||
|
||||
|
||||
@ -69,6 +69,9 @@ package org.apache.poi.hpsf;
|
||||
public class IllegalPropertySetDataException extends HPSFRuntimeException
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*/
|
||||
public IllegalPropertySetDataException()
|
||||
{
|
||||
super();
|
||||
@ -76,6 +79,11 @@ public class IllegalPropertySetDataException extends HPSFRuntimeException
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
*/
|
||||
public IllegalPropertySetDataException(final String msg)
|
||||
{
|
||||
super(msg);
|
||||
@ -83,6 +91,11 @@ public class IllegalPropertySetDataException extends HPSFRuntimeException
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public IllegalPropertySetDataException(final Throwable reason)
|
||||
{
|
||||
super(reason);
|
||||
@ -90,10 +103,16 @@ public class IllegalPropertySetDataException extends HPSFRuntimeException
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public IllegalPropertySetDataException(final String msg,
|
||||
final Throwable reason)
|
||||
{
|
||||
super(msg,reason);
|
||||
super(msg, reason);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -65,24 +65,43 @@ package org.apache.poi.hpsf;
|
||||
public class MarkUnsupportedException extends HPSFException
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*/
|
||||
public MarkUnsupportedException()
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
*/
|
||||
public MarkUnsupportedException(final String msg)
|
||||
{
|
||||
super(msg);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public MarkUnsupportedException(final Throwable reason)
|
||||
{
|
||||
super(reason);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public MarkUnsupportedException(final String msg, final Throwable reason)
|
||||
{
|
||||
super(msg, reason);
|
||||
|
||||
@ -71,24 +71,43 @@ package org.apache.poi.hpsf;
|
||||
public class NoPropertySetStreamException extends HPSFException
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*/
|
||||
public NoPropertySetStreamException()
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
*/
|
||||
public NoPropertySetStreamException(final String msg)
|
||||
{
|
||||
super(msg);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public NoPropertySetStreamException(final Throwable reason)
|
||||
{
|
||||
super(reason);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public NoPropertySetStreamException(final String msg,
|
||||
final Throwable reason)
|
||||
{
|
||||
|
||||
@ -70,24 +70,43 @@ package org.apache.poi.hpsf;
|
||||
public class NoSingleSectionException extends HPSFRuntimeException
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*/
|
||||
public NoSingleSectionException()
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
*/
|
||||
public NoSingleSectionException(final String msg)
|
||||
{
|
||||
super(msg);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public NoSingleSectionException(final Throwable reason)
|
||||
{
|
||||
super(reason);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Constructor</p>
|
||||
*
|
||||
* @param msg The exception's message string
|
||||
* @param reason This exception's underlying reason
|
||||
*/
|
||||
public NoSingleSectionException(final String msg, final Throwable reason)
|
||||
{
|
||||
super(msg, reason);
|
||||
|
||||
@ -62,7 +62,8 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import org.apache.poi.util.LittleEndian;
|
||||
|
||||
/**
|
||||
@ -95,9 +96,10 @@ import org.apache.poi.util.LittleEndian;
|
||||
public class Property
|
||||
{
|
||||
|
||||
/* Codepage 1200 denotes Unicode. */
|
||||
private static int CP_UNICODE = 1200;
|
||||
/** <p>Codepage 1200 denotes Unicode.</p> */
|
||||
private static final int CP_UNICODE = 1200;
|
||||
|
||||
/** <p>The property's ID.</p> */
|
||||
private int id;
|
||||
|
||||
|
||||
@ -113,6 +115,7 @@ public class Property
|
||||
|
||||
|
||||
|
||||
/** <p>The property's type.</p> */
|
||||
private long type;
|
||||
|
||||
|
||||
@ -128,6 +131,7 @@ public class Property
|
||||
|
||||
|
||||
|
||||
/** <p>The property's value.</p> */
|
||||
private Object value;
|
||||
|
||||
|
||||
@ -156,7 +160,7 @@ public class Property
|
||||
* codepage. It is needed only when reading string values.
|
||||
*/
|
||||
public Property(final int id, final byte[] src, final long offset,
|
||||
int length, int codepage)
|
||||
final int length, final int codepage)
|
||||
{
|
||||
this.id = id;
|
||||
|
||||
@ -258,4 +262,17 @@ public class Property
|
||||
return m;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>Returns the property's size in bytes. This is always a multiple of
|
||||
* 4.</p>
|
||||
*
|
||||
* @return the property's size in bytes
|
||||
*/
|
||||
protected int getSize()
|
||||
{
|
||||
throw new UnsupportedOperationException("FIXME: Not yet implemented.");
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -54,10 +54,11 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.io.*;
|
||||
import java.util.*;
|
||||
import org.apache.poi.hpsf.wellknown.*;
|
||||
import org.apache.poi.poifs.filesystem.*;
|
||||
import java.io.InputStream;
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import org.apache.poi.hpsf.wellknown.SectionIDMap;
|
||||
import org.apache.poi.util.LittleEndian;
|
||||
|
||||
/**
|
||||
@ -99,8 +100,8 @@ public class PropertySet
|
||||
/**
|
||||
* <p>The "byteOrder" field must equal this value.</p>
|
||||
*/
|
||||
final static byte[] BYTE_ORDER_ASSERTION =
|
||||
new byte[]{(byte) 0xFE, (byte) 0xFF};
|
||||
static final byte[] BYTE_ORDER_ASSERTION =
|
||||
new byte[] {(byte) 0xFE, (byte) 0xFF};
|
||||
|
||||
/**
|
||||
* <p>Specifies this {@link PropertySet}'s byte order. See the
|
||||
@ -124,7 +125,7 @@ public class PropertySet
|
||||
/**
|
||||
* <p>The "format" field must equal this value.</p>
|
||||
*/
|
||||
final static byte[] FORMAT_ASSERTION =
|
||||
static final byte[] FORMAT_ASSERTION =
|
||||
new byte[]{(byte) 0x00, (byte) 0x00};
|
||||
|
||||
/**
|
||||
@ -154,21 +155,31 @@ public class PropertySet
|
||||
protected int osVersion;
|
||||
|
||||
|
||||
public final static int OS_WIN16 = 0x0000;
|
||||
public final static int OS_MACINTOSH = 0x0001;
|
||||
public final static int OS_WIN32 = 0x0002;
|
||||
/**
|
||||
* <p>If the OS version field holds this value the property set stream was
|
||||
* created on a 16-bit Windows system.</p>
|
||||
*/
|
||||
public static final int OS_WIN16 = 0x0000;
|
||||
|
||||
/**
|
||||
* <p>If the OS version field holds this value the property set stream was
|
||||
* created on a Macintosh system.</p>
|
||||
*/
|
||||
public static final int OS_MACINTOSH = 0x0001;
|
||||
|
||||
/**
|
||||
* <p>If the OS version field holds this value the property set stream was
|
||||
* created on a 32-bit Windows system.</p>
|
||||
*/
|
||||
public static final int OS_WIN32 = 0x0002;
|
||||
|
||||
/**
|
||||
* <p>Returns the property set stream's low-level "OS version"
|
||||
* field.</p>
|
||||
*
|
||||
* <p><strong>FIXME:</strong> Return an <code>int</code> instead
|
||||
* of a <code>long</code> in the next major version, i.e. when
|
||||
* incompatible changes are allowed.</p>
|
||||
*
|
||||
* @return The property set stream's low-level "OS version" field.
|
||||
*/
|
||||
public long getOSVersion()
|
||||
public int getOSVersion()
|
||||
{
|
||||
return osVersion;
|
||||
}
|
||||
@ -204,13 +215,9 @@ public class PropertySet
|
||||
* <p>Returns the number of {@link Section}s in the property
|
||||
* set.</p>
|
||||
*
|
||||
* <p><strong>FIXME:</strong> Return an <code>int</code> instead
|
||||
* of a <code>long</code> in the next major version, i.e. when
|
||||
* incompatible changes are allowed.</p>
|
||||
*
|
||||
* @return The number of {@link Section}s in the property set.
|
||||
*/
|
||||
public long getSectionCount()
|
||||
public int getSectionCount()
|
||||
{
|
||||
return sectionCount;
|
||||
}
|
||||
@ -244,7 +251,7 @@ public class PropertySet
|
||||
* writing functionality is implemented.</p>
|
||||
*/
|
||||
protected PropertySet()
|
||||
{}
|
||||
{ }
|
||||
|
||||
|
||||
|
||||
@ -265,6 +272,8 @@ public class PropertySet
|
||||
* the {@link InputStream#markSupported} method.
|
||||
* @throws IOException if the {@link InputStream} cannot not be
|
||||
* accessed as needed.
|
||||
* @exception NoPropertySetStreamException if the input stream does not
|
||||
* contain a property set
|
||||
*/
|
||||
public PropertySet(final InputStream stream)
|
||||
throws NoPropertySetStreamException, MarkUnsupportedException,
|
||||
@ -337,6 +346,7 @@ public class PropertySet
|
||||
* stream, else <code>false</code>.
|
||||
* @throws MarkUnsupportedException if the {@link InputStream}
|
||||
* does not support the {@link InputStream#mark} method.
|
||||
* @exception IOException if an I/O error occurs
|
||||
*/
|
||||
public static boolean isPropertySetStream(final InputStream stream)
|
||||
throws MarkUnsupportedException, IOException
|
||||
@ -381,31 +391,35 @@ public class PropertySet
|
||||
* @return <code>true</code> if the byte array is a property set
|
||||
* stream, <code>false</code> if not.
|
||||
*/
|
||||
public static boolean isPropertySetStream(final byte[] src, int offset,
|
||||
public static boolean isPropertySetStream(final byte[] src,
|
||||
final int offset,
|
||||
final int length)
|
||||
{
|
||||
/* FIXME: Ensure that at most "length" bytes are read. */
|
||||
|
||||
/*
|
||||
* Read the header fields of the stream. They must always be
|
||||
* there.
|
||||
*/
|
||||
final int byteOrder = LittleEndian.getUShort(src, offset);
|
||||
offset += LittleEndian.SHORT_SIZE;
|
||||
int o = offset;
|
||||
final int byteOrder = LittleEndian.getUShort(src, o);
|
||||
o += LittleEndian.SHORT_SIZE;
|
||||
byte[] temp = new byte[LittleEndian.SHORT_SIZE];
|
||||
LittleEndian.putShort(temp,(short)byteOrder);
|
||||
LittleEndian.putShort(temp, (short) byteOrder);
|
||||
if (!Util.equal(temp, BYTE_ORDER_ASSERTION))
|
||||
return false;
|
||||
final int format = LittleEndian.getUShort(src, offset);
|
||||
offset += LittleEndian.SHORT_SIZE;
|
||||
final int format = LittleEndian.getUShort(src, o);
|
||||
o += LittleEndian.SHORT_SIZE;
|
||||
temp = new byte[LittleEndian.SHORT_SIZE];
|
||||
LittleEndian.putShort(temp,(short)format);
|
||||
LittleEndian.putShort(temp, (short) format);
|
||||
if (!Util.equal(temp, FORMAT_ASSERTION))
|
||||
return false;
|
||||
final long osVersion = LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
final ClassID classID = new ClassID(src, offset);
|
||||
offset += ClassID.LENGTH;
|
||||
final long sectionCount = LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
// final long osVersion = LittleEndian.getUInt(src, offset);
|
||||
o += LittleEndian.INT_SIZE;
|
||||
// final ClassID classID = new ClassID(src, offset);
|
||||
o += ClassID.LENGTH;
|
||||
final long sectionCount = LittleEndian.getUInt(src, o);
|
||||
o += LittleEndian.INT_SIZE;
|
||||
if (sectionCount < 1)
|
||||
return false;
|
||||
return true;
|
||||
@ -424,21 +438,24 @@ public class PropertySet
|
||||
* from the beginning of <var>src</src>
|
||||
* @param length Length of the property set stream.
|
||||
*/
|
||||
private void init(final byte[] src, int offset, final int length)
|
||||
private void init(final byte[] src, final int offset, final int length)
|
||||
{
|
||||
/* FIXME: Ensure that at most "length" bytes are read. */
|
||||
|
||||
/*
|
||||
* Read the stream's header fields.
|
||||
*/
|
||||
byteOrder = LittleEndian.getUShort(src, offset);
|
||||
offset += LittleEndian.SHORT_SIZE;
|
||||
format = LittleEndian.getUShort(src, offset);
|
||||
offset += LittleEndian.SHORT_SIZE;
|
||||
osVersion = (int) LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
classID = new ClassID(src, offset);
|
||||
offset += ClassID.LENGTH;
|
||||
sectionCount = LittleEndian.getInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
int o = offset;
|
||||
byteOrder = LittleEndian.getUShort(src, o);
|
||||
o += LittleEndian.SHORT_SIZE;
|
||||
format = LittleEndian.getUShort(src, o);
|
||||
o += LittleEndian.SHORT_SIZE;
|
||||
osVersion = (int) LittleEndian.getUInt(src, o);
|
||||
o += LittleEndian.INT_SIZE;
|
||||
classID = new ClassID(src, o);
|
||||
o += ClassID.LENGTH;
|
||||
sectionCount = LittleEndian.getInt(src, o);
|
||||
o += LittleEndian.INT_SIZE;
|
||||
if (sectionCount <= 0)
|
||||
throw new HPSFRuntimeException("Section count " + sectionCount +
|
||||
" must be greater than 0.");
|
||||
@ -464,8 +481,8 @@ public class PropertySet
|
||||
*/
|
||||
for (int i = 0; i < sectionCount; i++)
|
||||
{
|
||||
final Section s = new Section(src, offset);
|
||||
offset += ClassID.LENGTH + LittleEndian.INT_SIZE;
|
||||
final Section s = new Section(src, o);
|
||||
o += ClassID.LENGTH + LittleEndian.INT_SIZE;
|
||||
sections.add(s);
|
||||
}
|
||||
}
|
||||
@ -609,9 +626,7 @@ public class PropertySet
|
||||
* <p>If the {@link PropertySet} has only a single section this
|
||||
* method returns it.</p>
|
||||
*
|
||||
*@return The singleSection value
|
||||
*@throws NoSingleSectionException if the {@link PropertySet} has
|
||||
*more or less than exactly one {@link Section}.
|
||||
* @return The singleSection value
|
||||
*/
|
||||
public Section getSingleSection()
|
||||
{
|
||||
|
||||
@ -54,7 +54,8 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.io.*;
|
||||
import java.io.InputStream;
|
||||
import java.io.IOException;
|
||||
|
||||
/**
|
||||
* <p>Factory class to create instances of {@link SummaryInformation},
|
||||
|
||||
@ -54,9 +54,10 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.Map;
|
||||
import org.apache.poi.util.LittleEndian;
|
||||
import org.apache.poi.hpsf.wellknown.*;
|
||||
import org.apache.poi.hpsf.wellknown.PropertyIDMap;
|
||||
import org.apache.poi.hpsf.wellknown.SectionIDMap;
|
||||
|
||||
/**
|
||||
* <p>Represents a section in a {@link PropertySet}.</p>
|
||||
@ -75,6 +76,9 @@ public class Section
|
||||
*/
|
||||
protected Map dictionary;
|
||||
|
||||
/**
|
||||
* <p>The section's format ID, {@link #getFormatID}.</p>
|
||||
*/
|
||||
protected ClassID formatID;
|
||||
|
||||
|
||||
@ -95,6 +99,9 @@ public class Section
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see #getOffset
|
||||
*/
|
||||
protected long offset;
|
||||
|
||||
|
||||
@ -110,6 +117,9 @@ public class Section
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see #getSize
|
||||
*/
|
||||
protected int size;
|
||||
|
||||
|
||||
@ -125,6 +135,9 @@ public class Section
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see #getPropertyCount
|
||||
*/
|
||||
protected int propertyCount;
|
||||
|
||||
|
||||
@ -140,6 +153,9 @@ public class Section
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see #getProperties
|
||||
*/
|
||||
protected Property[] properties;
|
||||
|
||||
|
||||
@ -159,7 +175,7 @@ public class Section
|
||||
* <p>Creates an empty and uninitialized {@link Section}.
|
||||
*/
|
||||
protected Section()
|
||||
{}
|
||||
{ }
|
||||
|
||||
|
||||
|
||||
@ -170,32 +186,34 @@ public class Section
|
||||
* @param offset The position in the stream that points to the
|
||||
* section's format ID.
|
||||
*/
|
||||
public Section(final byte[] src, int offset)
|
||||
public Section(final byte[] src, final int offset)
|
||||
{
|
||||
int o1 = offset;
|
||||
|
||||
/*
|
||||
* Read the format ID.
|
||||
*/
|
||||
formatID = new ClassID(src, offset);
|
||||
offset += ClassID.LENGTH;
|
||||
formatID = new ClassID(src, o1);
|
||||
o1 += ClassID.LENGTH;
|
||||
|
||||
/*
|
||||
* Read the offset from the stream's start and positions to
|
||||
* the section header.
|
||||
*/
|
||||
this.offset = LittleEndian.getUInt(src, offset);
|
||||
offset = (int)this.offset;
|
||||
this.offset = LittleEndian.getUInt(src, o1);
|
||||
o1 = (int) this.offset;
|
||||
|
||||
/*
|
||||
* Read the section length.
|
||||
*/
|
||||
size = (int)LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
size = (int) LittleEndian.getUInt(src, o1);
|
||||
o1 += LittleEndian.INT_SIZE;
|
||||
|
||||
/*
|
||||
* Read the number of properties.
|
||||
*/
|
||||
propertyCount = (int)LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
propertyCount = (int) LittleEndian.getUInt(src, o1);
|
||||
o1 += LittleEndian.INT_SIZE;
|
||||
|
||||
/*
|
||||
* Read the properties. The offset is positioned at the first
|
||||
@ -213,11 +231,10 @@ public class Section
|
||||
* number. The seconds pass reads the other properties.
|
||||
*/
|
||||
properties = new Property[propertyCount];
|
||||
Property propertyOne;
|
||||
|
||||
/* Pass 1: Look for the codepage. */
|
||||
int codepage = -1;
|
||||
int pass1Offset = offset;
|
||||
int pass1Offset = o1;
|
||||
for (int i = 0; i < properties.length; i++)
|
||||
{
|
||||
/* Read the property ID. */
|
||||
@ -229,13 +246,13 @@ public class Section
|
||||
pass1Offset += LittleEndian.INT_SIZE;
|
||||
|
||||
/* Calculate the length of the property. */
|
||||
int length;
|
||||
if (i == properties.length - 1)
|
||||
length = (int) (src.length - this.offset - sOffset);
|
||||
else
|
||||
length = (int)
|
||||
LittleEndian.getUInt(src, pass1Offset +
|
||||
LittleEndian.INT_SIZE) - sOffset;
|
||||
// int length;
|
||||
// if (i == properties.length - 1)
|
||||
// length = (int) (src.length - this.offset - sOffset);
|
||||
// else
|
||||
// length = (int)
|
||||
// LittleEndian.getUInt(src, pass1Offset +
|
||||
// LittleEndian.INT_SIZE) - sOffset;
|
||||
|
||||
if (id == PropertyIDMap.PID_CODEPAGE)
|
||||
{
|
||||
@ -261,12 +278,12 @@ public class Section
|
||||
for (int i = 0; i < properties.length; i++)
|
||||
{
|
||||
/* Read the property ID. */
|
||||
final int id = (int) LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
final int id = (int) LittleEndian.getUInt(src, o1);
|
||||
o1 += LittleEndian.INT_SIZE;
|
||||
|
||||
/* Offset from the section. */
|
||||
final int sOffset = (int) LittleEndian.getUInt(src, offset);
|
||||
offset += LittleEndian.INT_SIZE;
|
||||
final int sOffset = (int) LittleEndian.getUInt(src, o1);
|
||||
o1 += LittleEndian.INT_SIZE;
|
||||
|
||||
/* Calculate the length of the property. */
|
||||
int length;
|
||||
@ -274,7 +291,7 @@ public class Section
|
||||
length = (int) (src.length - this.offset - sOffset);
|
||||
else
|
||||
length = (int)
|
||||
LittleEndian.getUInt(src, offset + LittleEndian.INT_SIZE) -
|
||||
LittleEndian.getUInt(src, o1 + LittleEndian.INT_SIZE) -
|
||||
sOffset;
|
||||
|
||||
/* Create it. */
|
||||
@ -325,9 +342,7 @@ public class Section
|
||||
*/
|
||||
protected int getPropertyIntValue(final int id)
|
||||
{
|
||||
/* FIXME: Find out why the following is a Long instead of an
|
||||
* Integer! */
|
||||
final Long i = (Long) getProperty(id);
|
||||
final Integer i = (Integer) getProperty(id);
|
||||
if (i != null)
|
||||
return i.intValue();
|
||||
else
|
||||
@ -358,6 +373,11 @@ public class Section
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* <p>This member is <code>true</code> if the last call to {@link
|
||||
* #getPropertyIntValue} or {@link #getProperty} tried to access a
|
||||
* property that was not available, else <code>false</code>.</p>
|
||||
*/
|
||||
private boolean wasNull;
|
||||
|
||||
|
||||
|
||||
@ -54,8 +54,7 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.util.*;
|
||||
import org.apache.poi.util.LittleEndian;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* <p>Abstract superclass for the convenience classes {@link
|
||||
@ -90,17 +89,30 @@ import org.apache.poi.util.LittleEndian;
|
||||
public abstract class SpecialPropertySet extends PropertySet
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>The "real" property set <code>SpecialPropertySet</code>
|
||||
* delegates to.</p>
|
||||
*/
|
||||
private PropertySet delegate;
|
||||
|
||||
|
||||
|
||||
public SpecialPropertySet(PropertySet ps)
|
||||
/**
|
||||
* <p>Creates a <code>SpecialPropertySet</code>.
|
||||
*
|
||||
* @param ps The property set encapsulated by the
|
||||
* <code>SpecialPropertySet</code>
|
||||
*/
|
||||
public SpecialPropertySet(final PropertySet ps)
|
||||
{
|
||||
delegate = ps;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#getByteOrder
|
||||
*/
|
||||
public int getByteOrder()
|
||||
{
|
||||
return delegate.getByteOrder();
|
||||
@ -108,6 +120,9 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#getFormat
|
||||
*/
|
||||
public int getFormat()
|
||||
{
|
||||
return delegate.getFormat();
|
||||
@ -115,20 +130,19 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* This is intentionally no javadoc comment.
|
||||
*
|
||||
* FIXME: Return an <code>int</code> instead of a
|
||||
* <code>long</code> in the next major version, i.e. when
|
||||
* incompatible changes are allowed.
|
||||
/**
|
||||
* @see PropertySet#getOSVersion
|
||||
*/
|
||||
public long getOSVersion()
|
||||
public int getOSVersion()
|
||||
{
|
||||
return delegate.getOSVersion();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#getClassID
|
||||
*/
|
||||
public ClassID getClassID()
|
||||
{
|
||||
return delegate.getClassID();
|
||||
@ -136,20 +150,19 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* This is intentionally no javadoc comment.
|
||||
*
|
||||
* FIXME: Return an <code>int</code> instead of a
|
||||
* <code>long</code> in the next major version, i.e. when
|
||||
* incompatible changes are allowed.
|
||||
/**
|
||||
* @see PropertySet#getSectionCount
|
||||
*/
|
||||
public long getSectionCount()
|
||||
public int getSectionCount()
|
||||
{
|
||||
return delegate.getSectionCount();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#getSections
|
||||
*/
|
||||
public List getSections()
|
||||
{
|
||||
return delegate.getSections();
|
||||
@ -157,6 +170,9 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#isSummaryInformation
|
||||
*/
|
||||
public boolean isSummaryInformation()
|
||||
{
|
||||
return delegate.isSummaryInformation();
|
||||
@ -164,6 +180,9 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#isDocumentSummaryInformation
|
||||
*/
|
||||
public boolean isDocumentSummaryInformation()
|
||||
{
|
||||
return delegate.isDocumentSummaryInformation();
|
||||
@ -171,6 +190,9 @@ public abstract class SpecialPropertySet extends PropertySet
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @see PropertySet#getSingleSection
|
||||
*/
|
||||
public Section getSingleSection()
|
||||
{
|
||||
return delegate.getSingleSection();
|
||||
|
||||
@ -58,9 +58,8 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.io.*;
|
||||
import java.util.*;
|
||||
import org.apache.poi.hpsf.wellknown.*;
|
||||
import java.util.Date;
|
||||
import org.apache.poi.hpsf.wellknown.PropertyIDMap;
|
||||
|
||||
/**
|
||||
* <p>Convenience class representing a Summary Information stream in a
|
||||
|
||||
@ -208,7 +208,7 @@ public class Thumbnail
|
||||
*
|
||||
* @param thumbnailData The thumbnail data
|
||||
*/
|
||||
public Thumbnail(byte[] thumbnailData)
|
||||
public Thumbnail(final byte[] thumbnailData)
|
||||
{
|
||||
this.thumbnailData = thumbnailData;
|
||||
}
|
||||
@ -236,7 +236,7 @@ public class Thumbnail
|
||||
* @param thumbnail The new thumbnail value
|
||||
* @see SummaryInformation#getThumbnail()
|
||||
*/
|
||||
public void setThumbnail(byte[] thumbnail)
|
||||
public void setThumbnail(final byte[] thumbnail)
|
||||
{
|
||||
this.thumbnailData = thumbnail;
|
||||
}
|
||||
|
||||
@ -69,24 +69,48 @@ package org.apache.poi.hpsf;
|
||||
public class UnexpectedPropertySetTypeException extends HPSFException
|
||||
{
|
||||
|
||||
/**
|
||||
* <p>Creates an {@link UnexpectedPropertySetTypeException}.</p>
|
||||
*/
|
||||
public UnexpectedPropertySetTypeException()
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates an {@link UnexpectedPropertySetTypeException} with a message
|
||||
* string.</p>
|
||||
*
|
||||
* @param msg The message string.
|
||||
*/
|
||||
public UnexpectedPropertySetTypeException(final String msg)
|
||||
{
|
||||
super(msg);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates a new {@link UnexpectedPropertySetTypeException} with a
|
||||
* reason.</p>
|
||||
*
|
||||
* @param reason The reason, i.e. a throwable that indirectly
|
||||
* caused this exception.
|
||||
*/
|
||||
public UnexpectedPropertySetTypeException(final Throwable reason)
|
||||
{
|
||||
super(reason);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* <p>Creates an {@link UnexpectedPropertySetTypeException} with a message
|
||||
* string and a reason.</p>
|
||||
*
|
||||
* @param msg The message string.
|
||||
* @param reason The reason, i.e. a throwable that indirectly
|
||||
* caused this exception.
|
||||
*/
|
||||
public UnexpectedPropertySetTypeException(final String msg,
|
||||
final Throwable reason)
|
||||
{
|
||||
|
||||
@ -54,7 +54,7 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* <p>Provides various static utility methods.</p>
|
||||
@ -167,7 +167,7 @@ public class Util
|
||||
* did you notice that you can tell from the epochs which
|
||||
* operating system is the modern one? :-))</p>
|
||||
*/
|
||||
public final static long EPOCH_DIFF = 11644473600000L;
|
||||
public static final long EPOCH_DIFF = 11644473600000L;
|
||||
|
||||
|
||||
/**
|
||||
|
||||
@ -54,7 +54,7 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf.wellknown;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.HashMap;
|
||||
|
||||
/**
|
||||
* <p>This is a dictionary which maps property ID values to property
|
||||
@ -66,10 +66,10 @@ import java.util.*;
|
||||
* should treat them as unmodifiable, copy them and modifiy the
|
||||
* copies.</p>
|
||||
*
|
||||
* <p><strong>FIXME:</strong> Make the singletons
|
||||
* unmodifiable. However, since this requires to use a {@link HashMap}
|
||||
* delegate instead of extending {@link HashMap} and thus requires a
|
||||
* lot of stupid typing. I won't do that for the time being.</p>
|
||||
* <p><strong>FIXME:</strong> Make the singletons unmodifiable. However,
|
||||
* since this requires to use a {@link HashMap} delegate instead of
|
||||
* extending {@link HashMap} and thus requires a lot of stupid typing. I won't
|
||||
* do that for the time being.</p>
|
||||
*
|
||||
* @author Rainer Klute (klute@rainer-klute.de)
|
||||
* @version $Id$
|
||||
@ -82,24 +82,67 @@ public class PropertyIDMap extends HashMap
|
||||
* The following definitions are for property IDs in the first
|
||||
* (and only) section of the Summary Information property set.
|
||||
*/
|
||||
public final static int PID_TITLE = 2;
|
||||
public final static int PID_SUBJECT = 3;
|
||||
public final static int PID_AUTHOR = 4;
|
||||
public final static int PID_KEYWORDS = 5;
|
||||
public final static int PID_COMMENTS = 6;
|
||||
public final static int PID_TEMPLATE = 7;
|
||||
public final static int PID_LASTAUTHOR = 8;
|
||||
public final static int PID_REVNUMBER = 9;
|
||||
public final static int PID_EDITTIME = 10;
|
||||
public final static int PID_LASTPRINTED = 11;
|
||||
public final static int PID_CREATE_DTM = 12;
|
||||
public final static int PID_LASTSAVE_DTM = 13;
|
||||
public final static int PID_PAGECOUNT = 14;
|
||||
public final static int PID_WORDCOUNT = 15;
|
||||
public final static int PID_CHARCOUNT = 16;
|
||||
public final static int PID_THUMBNAIL = 17;
|
||||
public final static int PID_APPNAME = 18;
|
||||
public final static int PID_SECURITY = 19;
|
||||
|
||||
/** <p>ID of the property that denotes the document's title</p> */
|
||||
public static final int PID_TITLE = 2;
|
||||
|
||||
/** <p>ID of the property that denotes the document's subject</p> */
|
||||
public static final int PID_SUBJECT = 3;
|
||||
|
||||
/** <p>ID of the property that denotes the document's author</p> */
|
||||
public static final int PID_AUTHOR = 4;
|
||||
|
||||
/** <p>ID of the property that denotes the document's keywords</p> */
|
||||
public static final int PID_KEYWORDS = 5;
|
||||
|
||||
/** <p>ID of the property that denotes the document's comments</p> */
|
||||
public static final int PID_COMMENTS = 6;
|
||||
|
||||
/** <p>ID of the property that denotes the document's template</p> */
|
||||
public static final int PID_TEMPLATE = 7;
|
||||
|
||||
/** <p>ID of the property that denotes the document's last author</p> */
|
||||
public static final int PID_LASTAUTHOR = 8;
|
||||
|
||||
/** <p>ID of the property that denotes the document's revision number</p> */
|
||||
public static final int PID_REVNUMBER = 9;
|
||||
|
||||
/** <p>ID of the property that denotes the document's edit time</p> */
|
||||
public static final int PID_EDITTIME = 10;
|
||||
|
||||
/** <p>ID of the property that denotes the date and time the document was
|
||||
* last printed</p> */
|
||||
public static final int PID_LASTPRINTED = 11;
|
||||
|
||||
/** <p>ID of the property that denotes the date and time the document was
|
||||
* created.</p> */
|
||||
public static final int PID_CREATE_DTM = 12;
|
||||
|
||||
/** <p>ID of the property that denotes the date and time the document was
|
||||
* saved</p> */
|
||||
public static final int PID_LASTSAVE_DTM = 13;
|
||||
|
||||
/** <p>ID of the property that denotes the number of pages in the
|
||||
* document</p> */
|
||||
public static final int PID_PAGECOUNT = 14;
|
||||
|
||||
/** <p>ID of the property that denotes the number of words in the
|
||||
* document</p> */
|
||||
public static final int PID_WORDCOUNT = 15;
|
||||
|
||||
/** <p>ID of the property that denotes the number of characters in the
|
||||
* document</p> */
|
||||
public static final int PID_CHARCOUNT = 16;
|
||||
|
||||
/** <p>ID of the property that denotes the document's thumbnail</p> */
|
||||
public static final int PID_THUMBNAIL = 17;
|
||||
|
||||
/** <p>ID of the property that denotes the application that created the
|
||||
* document</p> */
|
||||
public static final int PID_APPNAME = 18;
|
||||
|
||||
/** <p>ID of the property that denotes... FIXME</p> */
|
||||
public static final int PID_SECURITY = 19;
|
||||
|
||||
|
||||
|
||||
@ -111,66 +154,66 @@ public class PropertyIDMap extends HashMap
|
||||
/**
|
||||
* <p>The entry is a dictionary.</p>
|
||||
*/
|
||||
public final static int PID_DICTIONARY = 0;
|
||||
public static final int PID_DICTIONARY = 0;
|
||||
|
||||
/**
|
||||
* <p>The entry denotes a code page.</p>
|
||||
*/
|
||||
public final static int PID_CODEPAGE = 1;
|
||||
public static final int PID_CODEPAGE = 1;
|
||||
|
||||
/**
|
||||
* <p>The entry is a string denoting the category the file belongs
|
||||
* to, e.g. review, memo, etc. This is useful to find documents of
|
||||
* same type.</p>
|
||||
*/
|
||||
public final static int PID_CATEGORY = 2;
|
||||
public static final int PID_CATEGORY = 2;
|
||||
|
||||
/**
|
||||
* <p>Target format for power point presentation, e.g. 35mm,
|
||||
* printer, video etc.</p>
|
||||
*/
|
||||
public final static int PID_PRESFORMAT = 3;
|
||||
public static final int PID_PRESFORMAT = 3;
|
||||
|
||||
/**
|
||||
* <p>Number of bytes.</p>
|
||||
*/
|
||||
public final static int PID_BYTECOUNT = 4;
|
||||
public static final int PID_BYTECOUNT = 4;
|
||||
|
||||
/**
|
||||
* <p>Number of lines.</p>
|
||||
*/
|
||||
public final static int PID_LINECOUNT = 5;
|
||||
public static final int PID_LINECOUNT = 5;
|
||||
|
||||
/**
|
||||
* <p>Number of paragraphs.</p>
|
||||
*/
|
||||
public final static int PID_PARCOUNT = 6;
|
||||
public static final int PID_PARCOUNT = 6;
|
||||
|
||||
/**
|
||||
* <p>Number of slides in a power point presentation.</p>
|
||||
*/
|
||||
public final static int PID_SLIDECOUNT = 7;
|
||||
public static final int PID_SLIDECOUNT = 7;
|
||||
|
||||
/**
|
||||
* <p>Number of slides with notes.</p>
|
||||
*/
|
||||
public final static int PID_NOTECOUNT = 8;
|
||||
public static final int PID_NOTECOUNT = 8;
|
||||
|
||||
/**
|
||||
* <p>Number of hidden slides.</p>
|
||||
*/
|
||||
public final static int PID_HIDDENCOUNT = 9;
|
||||
public static final int PID_HIDDENCOUNT = 9;
|
||||
|
||||
/**
|
||||
* <p>Number of multimedia clips, e.g. sound or video.</p>
|
||||
*/
|
||||
public final static int PID_MMCLIPCOUNT = 10;
|
||||
public static final int PID_MMCLIPCOUNT = 10;
|
||||
|
||||
/**
|
||||
* <p>This entry is set to -1 when scaling of the thumbnail is
|
||||
* desired. Otherwise the thumbnail should be cropped.</p>
|
||||
*/
|
||||
public final static int PID_SCALE = 11;
|
||||
public static final int PID_SCALE = 11;
|
||||
|
||||
/**
|
||||
* <p>This entry denotes an internally used property. It is a
|
||||
@ -179,30 +222,30 @@ public class PropertyIDMap extends HashMap
|
||||
* number tells how many document parts are under that
|
||||
* heading.</p>
|
||||
*/
|
||||
public final static int PID_HEADINGPAIR = 12;
|
||||
public static final int PID_HEADINGPAIR = 12;
|
||||
|
||||
/**
|
||||
* <p>This entry contains the names of document parts (word: names
|
||||
* of the documents in the master document, excel: sheet names,
|
||||
* power point: slide titles, binder: document names).</p>
|
||||
*/
|
||||
public final static int PID_DOCPARTS = 13;
|
||||
public static final int PID_DOCPARTS = 13;
|
||||
|
||||
/**
|
||||
* <p>This entry contains the name of the project manager.</p>
|
||||
*/
|
||||
public final static int PID_MANAGER = 14;
|
||||
public static final int PID_MANAGER = 14;
|
||||
|
||||
/**
|
||||
* <p>This entry contains the company name.</p>
|
||||
*/
|
||||
public final static int PID_COMPANY = 15;
|
||||
public static final int PID_COMPANY = 15;
|
||||
|
||||
/**
|
||||
* <p>If this entry is -1 the links are dirty and should be
|
||||
* re-evaluated.</p>
|
||||
*/
|
||||
public final static int PID_LINKSDIRTY = 16;
|
||||
public static final int PID_LINKSDIRTY = 16;
|
||||
|
||||
|
||||
|
||||
@ -224,8 +267,12 @@ public class PropertyIDMap extends HashMap
|
||||
|
||||
/**
|
||||
* <p>Creates a {@link PropertyIDMap}.</p>
|
||||
*
|
||||
* @param initialCapacity The initial capacity as defined for
|
||||
* {@link HashMap}
|
||||
* @param loadFactor The load factor as defined for {@link HashMap}
|
||||
*/
|
||||
public PropertyIDMap(int initialCapacity, float loadFactor)
|
||||
public PropertyIDMap(final int initialCapacity, final float loadFactor)
|
||||
{
|
||||
super(initialCapacity, loadFactor);
|
||||
}
|
||||
@ -238,12 +285,12 @@ public class PropertyIDMap extends HashMap
|
||||
*
|
||||
* @param id The ID.
|
||||
* @param idString The ID string.
|
||||
* @return As specified by the {@link Map} interface, this method
|
||||
* @return As specified by the {@link java.util.Map} interface, this method
|
||||
* returns the previous value associated with the specified
|
||||
* <var>id</var>, or <code>null</code> if there was no mapping for
|
||||
* key.
|
||||
*/
|
||||
public Object put(int id, String idString)
|
||||
public Object put(final int id, final String idString)
|
||||
{
|
||||
return put(new Integer(id), idString);
|
||||
}
|
||||
@ -257,7 +304,7 @@ public class PropertyIDMap extends HashMap
|
||||
* @param id The ID.
|
||||
* @return The ID string associated with <var>id</var>.
|
||||
*/
|
||||
public Object get(int id)
|
||||
public Object get(final int id)
|
||||
{
|
||||
return get(new Integer(id));
|
||||
}
|
||||
@ -265,7 +312,7 @@ public class PropertyIDMap extends HashMap
|
||||
|
||||
|
||||
/**
|
||||
* <p>Returns the Summary Information properties singleton.</p>
|
||||
* @return the Summary Information properties singleton
|
||||
*/
|
||||
public static PropertyIDMap getSummaryInformationProperties()
|
||||
{
|
||||
@ -334,8 +381,10 @@ public class PropertyIDMap extends HashMap
|
||||
|
||||
/**
|
||||
* <p>For the most basic testing.</p>
|
||||
*
|
||||
* @param args The command-line arguments
|
||||
*/
|
||||
public static void main(String args[])
|
||||
public static void main(final String[] args)
|
||||
{
|
||||
PropertyIDMap s1 = getSummaryInformationProperties();
|
||||
PropertyIDMap s2 = getDocumentSummaryInformationProperties();
|
||||
|
||||
@ -54,7 +54,7 @@
|
||||
*/
|
||||
package org.apache.poi.hpsf.wellknown;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.HashMap;
|
||||
|
||||
/**
|
||||
* <p>Maps section format IDs to {@link PropertyIDMap}s. It is
|
||||
@ -67,7 +67,7 @@ import java.util.*;
|
||||
* is well-known and you can query the {@link PropertyIDMap} for PID
|
||||
* strings. If you get back <code>null</code> you are on your own.</p>
|
||||
*
|
||||
* <p>This {@link Map} expects the byte arrays of section format IDs
|
||||
* <p>This {@link java.util.Map} expects the byte arrays of section format IDs
|
||||
* as keys. A key maps to a {@link PropertyIDMap} describing the
|
||||
* property IDs in sections with the specified section format ID.</p>
|
||||
*
|
||||
@ -81,7 +81,7 @@ public class SectionIDMap extends HashMap
|
||||
/**
|
||||
* <p>The SummaryInformation's section's format ID.</p>
|
||||
*/
|
||||
public final static byte[] SUMMARY_INFORMATION_ID = new byte[]
|
||||
public static final byte[] SUMMARY_INFORMATION_ID = new byte[]
|
||||
{
|
||||
(byte) 0xF2, (byte) 0x9F, (byte) 0x85, (byte) 0xE0,
|
||||
(byte) 0x4F, (byte) 0xF9, (byte) 0x10, (byte) 0x68,
|
||||
@ -94,7 +94,7 @@ public class SectionIDMap extends HashMap
|
||||
* ID. The second section has a different format ID which is not
|
||||
* well-known.</p>
|
||||
*/
|
||||
public final static byte[] DOCUMENT_SUMMARY_INFORMATION_ID = new byte[]
|
||||
public static final byte[] DOCUMENT_SUMMARY_INFORMATION_ID = new byte[]
|
||||
{
|
||||
(byte) 0xD5, (byte) 0xCD, (byte) 0xD5, (byte) 0x02,
|
||||
(byte) 0x2E, (byte) 0x9C, (byte) 0x10, (byte) 0x1B,
|
||||
@ -102,8 +102,15 @@ public class SectionIDMap extends HashMap
|
||||
(byte) 0x2B, (byte) 0x2C, (byte) 0xF9, (byte) 0xAE
|
||||
};
|
||||
|
||||
public final static String UNDEFINED = "[undefined]";
|
||||
/**
|
||||
* <p>A property without a known name is described by this string.</p>
|
||||
*/
|
||||
public static final String UNDEFINED = "[undefined]";
|
||||
|
||||
/**
|
||||
* <p>The default section ID map. It maps section format IDs to
|
||||
* {@link PropertyIDMap}s.</p>
|
||||
*/
|
||||
private static SectionIDMap defaultMap;
|
||||
|
||||
|
||||
@ -164,6 +171,9 @@ public class SectionIDMap extends HashMap
|
||||
/**
|
||||
* <p>Returns the {@link PropertyIDMap} for a given section format
|
||||
* ID.</p>
|
||||
*
|
||||
* @param sectionFormatID the section format ID
|
||||
* @return the property ID map
|
||||
*/
|
||||
public PropertyIDMap get(final byte[] sectionFormatID)
|
||||
{
|
||||
@ -178,6 +188,7 @@ public class SectionIDMap extends HashMap
|
||||
*
|
||||
* @param sectionFormatID A section format ID as a <tt>byte[]</tt> .
|
||||
* @deprecated Use {@link #get(byte[])} instead!
|
||||
* @return the property ID map
|
||||
*/
|
||||
public Object get(final Object sectionFormatID)
|
||||
{
|
||||
@ -189,6 +200,10 @@ public class SectionIDMap extends HashMap
|
||||
/**
|
||||
* <p>Associates a section format ID with a {@link
|
||||
* PropertyIDMap}.</p>
|
||||
*
|
||||
* @param sectionFormatID the section format ID
|
||||
* @param propertyIDMap the property ID map
|
||||
* @return as defined by {@link java.util.Map#put}
|
||||
*/
|
||||
public Object put(final byte[] sectionFormatID,
|
||||
final PropertyIDMap propertyIDMap)
|
||||
@ -200,6 +215,14 @@ public class SectionIDMap extends HashMap
|
||||
|
||||
/**
|
||||
* @deprecated Use {@link #put(byte[], PropertyIDMap)} instead!
|
||||
* @link #put(byte[], PropertyIDMap)
|
||||
*
|
||||
* @param key This parameter remains undocumented since the method is
|
||||
* deprecated.
|
||||
* @param value This parameter remains undocumented since the method is
|
||||
* deprecated.
|
||||
* @return The return value remains undocumented since the method is
|
||||
* deprecated.
|
||||
*/
|
||||
public Object put(final Object key, final Object value)
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user