* streams, however, are compared logically: they must have the same sections
* with the same attributs, and the sections must contain the same properties.
* Details like the ordering of the properties do not matter.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class CopyCompare
{
* <li><p>Write the POI filesystem back to the original file.</p></li>
*
* </ol>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
*/
public class ModifyDocumentSummaryInformation {
* Call it with the document's file name as command-line parameter.</p>
*
* <p>Explanations can be found in the HPSF HOW-TO.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class ReadCustomPropertySets
{
* parameter.</p>
*
* <p>Explanations can be found in the HPSF HOW-TO.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class ReadTitle
{
* summary information stream into the output file.</p>
*
* <p>Further explanations can be found in the HPSF HOW-TO.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class WriteAuthorAndTitle
{
/**
* <p>This class is a simple sample application showing how to create a property
* set and write it to disk.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class WriteTitle
{
/**
* <p>Describes the most important (whatever that is) features of a
* {@link POIFSDocument}.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class DocumentDescriptor
{
* <p>{@link TreeCellRenderer} for a {@link DocumentDescriptor}. The
* renderer is extremly rudimentary since displays only the document's
* name, its size and its fist few bytes.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class DocumentDescriptorRenderer extends DefaultTreeCellRenderer
{
* for the {@link Object} class, rendering is always possible. The
* default {@link Object} renderer can be replaced by another renderer
* but it cannot be unregistered.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class ExtendableTreeCellRenderer implements TreeCellRenderer
{
* JTree}. Specify their filenames on the command line!</p>
*
* @see POIFSReader
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
@SuppressWarnings("serial")
public class POIBrowser extends JFrame
/**
* <p>Describes the most important (whatever that is) features of a
* stream containing a {@link PropertySet}.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class PropertySetDescriptor extends DocumentDescriptor
{
/**
* <p>Renders a {@link PropertySetDescriptor} by more or less dumping
* the stuff into a {@link JTextArea}.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class PropertySetDescriptorRenderer extends DocumentDescriptorRenderer
{
* as many megabytes, an instance of {@link DocumentDescriptor} is a
* light-weight object and contains only some meta-information about a
* document.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class TreeReaderListener implements POIFSReaderListener
{
/**
* <p>Contains various (well, just one at the moment) static utility
* methods.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class Util {
* <p>While this class is roughly HashMap<Long,CustomProperty>, that's the
* internal representation. To external calls, it should appear as
* HashMap<String,Object> mapping between Names and Custom Property Values.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
@SuppressWarnings("serial")
public class CustomProperties extends HashMap<Object,CustomProperty>
* information stream. The difference to normal properties is that custom
* properties have an optional name. If the name is not <code>null</code> it
* will be maintained in the section's dictionary.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class CustomProperty extends MutableProperty
{
* <p>This exception is the superclass of all other checked exceptions thrown
* in this package. It supports a nested "reason" throwable, i.e. an exception
* that caused this one to be thrown.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class HPSFException extends Exception
{
* <p>This exception is the superclass of all other unchecked
* exceptions thrown in this package. It supports a nested "reason"
* throwable, i.e. an exception that caused this one to be thrown.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class HPSFRuntimeException extends RuntimeException
{
/**
* <p>This exception is thrown if HPSF encounters a variant type that is illegal
* in the current context.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class IllegalVariantTypeException extends VariantTypeException
{
/**
* <p>This exception is thrown if an {@link java.io.InputStream} does
* not support the {@link java.io.InputStream#mark} operation.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class MarkUnsupportedException extends HPSFException
{
*
* <p>The constructors of this class are analogous to those of its
* superclass and documented there.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class MissingSectionException extends HPSFRuntimeException
{
*
* <p>Please be aware that this class' functionality will be merged into the
* {@link Property} class at a later time, so the API will change.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class MutableProperty extends Property
{
*
* <p>Please be aware that this class' functionality will be merged into the
* {@link PropertySet} class at a later time, so the API will change.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class MutablePropertySet extends PropertySet
{
* but does not have a formatID set (see {@link
* MutableSection#setFormatID(ClassID)} or
* {@link org.apache.poi.hpsf.MutableSection#setFormatID(byte[])}.
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class NoFormatIDException extends HPSFRuntimeException
{
*
* <p>The constructors of this class are analogous to those of its superclass
* and are documented there.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class NoPropertySetStreamException extends HPSFException
{
*
* <p>The constructors of this class are analogous to those of its
* superclass and documented there.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class NoSingleSectionException extends HPSFRuntimeException
{
* a {@link PropertySet}'s {@link Section} (throwing a {@link
* NoSingleSectionException} if the {@link PropertySet} contains more
* (or less) than exactly one {@link Section}).</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
- * @author Drew Varner (Drew.Varner hanginIn sc.edu)
*/
public class PropertySet
{
*
* @see WritingNotSupportedException
* @see UnsupportedVariantTypeException
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class ReadingNotSupportedException
extends UnsupportedVariantTypeException
/**
* <p>Represents a section in a {@link PropertySet}.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
- * @author Drew Varner (Drew.Varner allUpIn sc.edu)
*/
public class Section
{
/**
* <p>Class for writing little-endian data and more.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class TypeWriter
{
*
* <p>The constructors of this class are analogous to those of its
* superclass and documented there.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class UnexpectedPropertySetTypeException extends HPSFException
{
* retrieved using the {@link VariantTypeException#getValue} method.</p>
*
* <p>Obviously this class should disappear some day.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public abstract class UnsupportedVariantTypeException
extends VariantTypeException
/**
* <p>Provides various static utility methods.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class Util
{
* <strong>[T]</strong> - may appear in a TYPEDESC,
* <strong>[P]</strong> - may appear in an OLE property set,
* <strong>[S]</strong> - may appear in a Safe Array.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class Variant
{
* output stream.</p></li>
*
* </ul>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class VariantSupport extends Variant
{
/**
* <p>This exception is thrown if HPSF encounters a problem with a variant type.
* Concrete subclasses specifiy the problem further.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public abstract class VariantTypeException extends HPSFException
{
*
* @see ReadingNotSupportedException
* @see UnsupportedVariantTypeException
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class WritingNotSupportedException
extends UnsupportedVariantTypeException
* PropertyIDMap}s. An application that wants to extend these maps
* should treat them as unmodifiable, copy them and modifiy the
* copies.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class PropertyIDMap extends HashMap<Long,String> {
* <p>Processes a test method for all OLE2 files in the HPSF test data
* directory. Well, this class does not check whether a file is an OLE2 file but
* rather whether its name begins with "Test".</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public class AllDataFilesTester {
private static final POIDataSamples _samples = POIDataSamples.getHPSFInstance();
/**
* <p>Interface specifying how to run a test on a single file.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public interface TestTask
{
/**
* <p>A POI file just for testing.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class POIFile
{
/**
* <p>Tests the basic HPSF functionality.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public final class TestBasic {
/**
* <p>Test case for OLE2 files with empty properties. An empty property's type
* is {@link Variant#VT_EMPTY}.</p>
- *
- * @author Rainer Klute <a
- * href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de></a>
*/
public final class TestEmptyProperties extends TestCase {
* <p>Tests some HPSF functionality by reading all property sets from all files
* in the "data" directory. If you want to ensure HPSF can deal with a certain
* OLE2 file, just add it to the "data" directory and run this test case.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class TestReadAllFiles extends TestCase {
private static String[] excludes = new String[] {};
/**
* <p>Tests whether Unicode string can be read from a
* DocumentSummaryInformation.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
public class TestUnicode extends TestCase {
/**
* <p>Static utility methods needed by the HPSF test cases.</p>
- *
- * @author Rainer Klute (klute@rainer-klute.de)
*/
final class Util {
projects / poi.git / commitdiff