NPOI.POIFS

A list of SmallDocumentBlocks instances, and methods to manage the list @author Marc Johnson (mjohnson at apache dot org)

Interface for lists of blocks that are mapped by block allocation tables @author Marc Johnson (mjohnson at apache dot org)

remove the specified block from the list

the index of the specified block; if the index is out of range, that's ok

Remove and return the specified block from the list

the index of the specified block the specified block

get the blocks making up a particular stream in the list. The blocks are removed from the list.

the index of the first block in the stream the stream as an array of correctly ordered blocks

set the associated BlockAllocationTable

the associated BlockAllocationTable

Initializes a new instance of the class.

provide blocks to manage

blocks to be managed

remove the specified block from the list

the index of the specified block; if the index is out of range, that's ok

Remove and return the specified block from the list

the index of the specified block the specified block

get the blocks making up a particular stream in the list. The blocks are removed from the list.

the index of the first block in the stream the stream as an array of correctly ordered blocks

set the associated BlockAllocationTable

the associated BlockAllocationTable

Initializes a new instance of the class.

a list of SmallDocumentBlock instances

This class implements reading the small document block list from an existing file @author Marc Johnson (mjohnson at apache dot org)

An interface for persisting block storage of POIFS components. @author Marc Johnson (mjohnson at apache dot org)

Writes the blocks.

The stream.

This interface defines behaviors for objects managed by the Block Allocation Table (BAT). @author Marc Johnson (mjohnson at apache dot org)

Gets the number of BigBlock's this instance uses

count of BigBlock instances

Sets the start block for this instance

index into the array of BigBlock instances making up the the filesystem

Initializes a new instance of the class.

a IList of POIFSDocument instances the Filesystem's root property

Write the storage to an OutputStream

the OutputStream to which the stored data should be written

Get the number of SBAT blocks

number of SBAT big blocks

Gets the SBAT.

the Small Block Allocation Table

Return the number of BigBlock's this instance uses

count of BigBlock instances

Sets the start block.

The start block.

This class implements reading the small document block list from an existing file @author Marc Johnson (mjohnson at apache dot org)

fetch the small document block list from an existing file

the raw data from which the small block table will be extracted the root property (which contains the start block and small block table size) the start block of the SBAT the small document block list

This class manages and creates the Block Allocation Table, which is basically a set of linked lists of block indices. Each block of the filesystem has an index. The first block, the header, is skipped; the first block after the header is index 0, the next is index 1, and so on. A block's index is also its index into the Block Allocation Table. The entry that it finds in the Block Allocation Table is the index of the next block in the linked list of blocks making up a file, or it is set to -2: end of list. * @author Marc Johnson (mjohnson at apache dot org)

Initializes a new instance of the class.

Create the BATBlocks we need

start block index of BAT blocks

Allocate space for a block of indices

the number of blocks to allocate space for the starting index of the blocks

create the BATBlocks

Write the storage to an OutputStream

the OutputStream to which the stored data should be written

Sets the start block for this instance

index into the array of BigBlock instances making up the the filesystem

Gets the number of BigBlock's this instance uses

count of BigBlock instances

This class manages and creates the Block Allocation Table, which is basically a set of linked lists of block indices. Each block of the filesystem has an index. The first block, the header, is skipped; the first block after the header is index 0, the next is index 1, and so on. A block's index is also its index into the Block Allocation Table. The entry that it finds in the Block Allocation Table is the index of the next block in the linked list of blocks making up a file, or it is set to -2: end of list. @author Marc Johnson (mjohnson at apache dot org)

create a BlockAllocationTableReader for an existing filesystem. Side effect: when this method finishes, the BAT blocks will have been Removed from the raw block list, and any blocks labeled as 'unused' in the block allocation table will also have been Removed from the raw block list.

the number of BAT blocks making up the block allocation table the array of BAT block indices from the filesystem's header the number of XBAT blocks the index of the first XBAT block the list of RawDataBlocks

create a BlockAllocationTableReader from an array of raw data blocks

the raw data the list holding the managed blocks

Initializes a new instance of the class.

walk the entries from a specified point and return the associated blocks. The associated blocks are Removed from the block list

the first block in the chain the raw data block list array of ListManagedBlocks, in their correct order

determine whether the block specified by index is used or not

determine whether the block specified by index is used or not true if the specified block is used; otherwise, false.

return the next block index

The index of the current block index of the next block (may be POIFSConstants.END_OF_CHAIN, indicating end of chain (duh))

Convert an array of blocks into a Set of integer indices

the array of blocks containing the indices the list of blocks being managed. Unused blocks will be eliminated from the list Default constructor reading constructor (used when we've read in a file and we want to extract the property table from it). Populates the properties thoroughly @param startBlock the first block of the property table @param blockList the list of blocks @exception IOException if anything goes wrong (which should be a result of the input being NFG) Add a property to the list of properties we manage @param property the new Property to manage Remove a property from the list of properties we manage @param property the Property to be Removed Prepare to be written Write the storage to an Stream @param stream the Stream to which the stored data should be written @exception IOException on problems writing to the specified stream Get the root property @return the root property Get the start block for the property table @return start block index Return the number of BigBlock's this instance uses @return count of BigBlock instances

This is the main class of the POIFS system; it manages the entire life cycle of the filesystem. @author Marc Johnson (mjohnson at apache dot org)

Interface for a drill-down viewable object. Such an object has content that may or may not be displayed, at the discretion of the viewer. The content is returned to the viewer as an array or as an Iterator, and the object provides a clue as to which technique the viewer should use to get its content. A POIFSViewable object is also expected to provide a short description of itself, that can be used by a viewer when the viewable object is collapsed. @author Marc Johnson (mjohnson at apache dot org)

Provides a short description of the object to be used when a POIFSViewable object has not provided its contents.

true if [prefer array]; otherwise, false.

Gets the short description.

The short description.

Get an array of objects, some of which may implement POIFSViewable

The viewable array.

Give viewers a hint as to whether to call ViewableArray or ViewableIterator

The viewable iterator.

Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.

The stream. A convenience method ( CreateNonClosingInputStream()) has been provided for this purpose: StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is); HSSFWorkbook wb = new HSSFWorkbook(wrappedStream); is.reset(); doSomethingElse(is); What big block size the file uses. Most files use 512 bytes, but a few use 4096

Initializes a new instance of the class. intended for writing

Create a POIFSFileSystem from an Stream. Normally the stream is Read until EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and needs to use it after this constructor completes, a work around is to wrap the stream in order to trap the Close() call.

the Streamfrom which to Read the data @param stream the stream to be Closed @param success false if an exception is currently being thrown in the calling method

Checks that the supplied Stream(which MUST support mark and reset, or be a PushbackInputStream) has a POIFS (OLE2) header at the start of it. If your Streamdoes not support mark / reset, then wrap it in a PushBackInputStream, then be sure to always use that, and not the original!

An Streamwhich supports either mark/reset, or is a PushbackStream true if [has POIFS header] [the specified inp]; otherwise, false.

Create a new document to be Added to the root directory

the Streamfrom which the document's data will be obtained the name of the new POIFSDocument the new DocumentEntry

Create a new DocumentEntry in the root entry; the data will be provided later

the name of the new DocumentEntry the size of the new DocumentEntry the Writer of the new DocumentEntry the new DocumentEntry

Create a new DirectoryEntry in the root directory

the name of the new DirectoryEntry the new DirectoryEntry

Writes the file system.

the OutputStream to which the filesystem will be written

open a document in the root entry's list of entries

the name of the document to be opened a newly opened POIFSDocumentReader

Add a new POIFSDocument

the POIFSDocument being Added

Add a new DirectoryProperty

The directory.

Removes the specified entry.

The entry.

Get the root entry

The root.

Get an array of objects, some of which may implement POIFSViewable

an array of Object; may not be null, but may be empty

Get an Iterator of objects, some of which may implement POIFSViewable

an Iterator; may not be null, but may have an empty back end store

Give viewers a hint as to whether to call GetViewableArray or GetViewableIterator

true if a viewer should call GetViewableArray, false if a viewer should call GetViewableIterator

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

The short description.

Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes

The size of the big block.

A block of Property instances @author Marc Johnson (mjohnson at apache dot org)

Abstract base class of all POIFS block storage classes. All extensions of BigBlock should write 512 bytes of data when requested to write their data. This class has package scope, as there is no reason at this time to make the class public. @author Marc Johnson (mjohnson at apache dot org)

Default implementation of write for extending classes that contain their data in a simple array of bytes.

the OutputStream to which the data should be written. the byte array of to be written.

Write the block's data to an OutputStream

the OutputStream to which the stored data should be written

Write the storage to an OutputStream

the OutputStream to which the stored data should be written

Create a single instance initialized with default values

the properties to be inserted the offset into the properties array

Create an array of PropertyBlocks from an array of Property instances, creating empty Property instances to make up any shortfall

the Property instances to be converted into PropertyBlocks, in a java List the array of newly created PropertyBlock instances

Write the block's data to an OutputStream

the OutputStream to which the stored data should be written

This abstract base class is the ancestor of all classes implementing POIFS Property behavior. @author Marc Johnson (mjohnson at apache dot org)

This interface defines methods for finding and setting sibling Property instances @author Marc Johnson (mjohnson at apache dot org)

Gets or sets the previous child.

The previous child.

Gets or sets the next child.

The next child.

Initializes a new instance of the class.

Constructor from byte data

index number byte data offset into byte data

Write the raw data to an OutputStream.

the OutputStream to which the data Should be written.

does the length indicate a small document?

length in bytes true if the length Is less than _big_block_minimum_bytes; otherwise, false.

Perform whatever activities need to be performed prior to writing

Determines whether the specified index Is valid

value to be checked true if the index Is valid; otherwise, false.

Gets or sets the start block for the document referred to by this Property.

the start block index

Based on the currently defined size, Should this property use small blocks?

true if the size Is less than _big_block_minimum_bytes

Gets or sets the name of this property

property name

Gets a value indicating whether this instance is directory.

true if a directory type Property; otherwise, false.

Gets or sets the storage class ID for this property stream. ThIs Is the Class ID of the COM object which can read and write this property stream

Storage Class ID

Set the property type. Makes no attempt to validate the value.

the property type (root, file, directory)

Sets the color of the node.

the node color (red or black)

Sets the child property.

the child property's index in the Property Table

Get the child property (its index in the Property Table)

The index of the child.

Gets or sets the size of the document associated with this Property

the size of the document, in bytes

Gets or sets the index.

The index. Get the index for this Property @return the index of this Property within its Property Table

Gets the index of the next child.

The index of the next child.

Gets the index of the previous child.

The index of the previous child.

Gets or sets the previous child.

the new 'previous' child; may be null, which has the effect of saying there Is no 'previous' child

Gets or sets the next Child

the new 'next' child; may be null, which has the effect of saying there Is no 'next' child

Get an array of objects, some of which may implement POIFSViewable

an array of Object; may not be null, but may be empty

Get an Iterator of objects, some of which may implement POIFSViewable

may not be null, but may have an empty back end store

Give viewers a hint as to whether to call GetViewableArray or GetViewableIterator

true if a viewer Should call GetViewableArray; otherwise, false if a viewer Should call GetViewableIterator

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

The short description.

The block containing the archive header @author Marc Johnson (mjohnson at apache dot org)

Create a single instance initialized with default values

Set BAT block parameters. Assumes that all BAT blocks are contiguous. Will construct XBAT blocks if necessary and return the array of newly constructed XBAT blocks.

count of BAT blocks index of first BAT block array of XBAT blocks; may be zero Length, will not be null

For a given number of BAT blocks, calculate how many XBAT blocks will be needed

number of BAT blocks number of XBAT blocks needed

Write the block's data to an Stream

the Stream to which the stored data should be written

Set start of Property Table

the index of the first block of the Property Table

Set start of small block allocation table

the index of the first big block of the small block allocation table

Set count of SBAT blocks

the number of SBAT blocks

The block containing the archive header @author Marc Johnson (mjohnson at apache dot org)

What big block Size the file uses. Most files use 512 bytes, but a few use 4096

create a new HeaderBlockReader from an Stream

the source Stream

Alerts the short read.

The read.

Get start of Property Table

the index of the first block of the Property Table

Gets start of small block allocation table

The SBAT start.

Gets number of BAT blocks

The BAT count.

Gets the BAT array.

The BAT array.

Gets the XBAT count.

The XBAT count. @return XBAT count

Gets the index of the XBAT.

The index of the XBAT.

Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes

The size of the big block. @return

Trivial extension of Property for POIFSDocuments @author Marc Johnson (mjohnson at apache dot org)

Behavior for parent (directory) properties @author Marc Johnson27591@hotmail.com

Add a new child to the collection of children

the new child to be added; must not be null

Get an iterator over the children of this Parent all elements are instances of Property.

Sets the previous child.

Sets the next child.

Initializes a new instance of the class.

the name of the directory

Initializes a new instance of the class.

index number byte data offset into byte data

Change a Property's name

the Property whose name Is being Changed. the new name for the Property true if the name Change could be made, else false

Delete a Property

the Property being Deleted true if the Property could be Deleted, else false

Perform whatever activities need to be performed prior to writing

Add a new child to the collection of children

the new child to be added; must not be null

Gets a value indicating whether this instance is directory.

true if a directory type Property; otherwise, false.

Get an iterator over the children of this Parent; all elements are instances of Property.

Iterator of children; may refer to an empty collection

Directory Property Comparer

Object equality, implemented as object identity

Object we're being Compared to true if identical, else false

Compare method. Assumes both parameters are non-null instances of Property. One property Is less than another if its name Is shorter than the other property's name. If the names are the same length, the property whose name comes before the other property's name, alphabetically, Is less than the other property.

first object to Compare, better be a Property second object to Compare, better be a Property negative value if o1 smaller than o2, zero if o1 equals o2, positive value if o1 bigger than o2.

EventArgs for POIFSWriter author: Tony Qu

Initializes a new instance of the class.

the POIFSDocumentWriter, freshly opened the path of the document the name of the document the limit, in bytes, that can be written to the stream

Gets the limit on writing, in bytes

The limit.

Gets the document's name

The name.

Gets the document's path

The path.

the POIFSDocumentWriter, freshly opened

The stream.

Storage for documents that are too small to use regular DocumentBlocks for their data @author Marc Johnson (mjohnson at apache dot org)

An interface for blocks managed by a list that works with a BlockAllocationTable to keep block sequences straight @author Marc Johnson (mjohnson at apache dot org

Get the data from the block

the block's data as a byte array

convert a single long array into an array of SmallDocumentBlock instances

the byte array to be converted the intended size of the array (which may be smaller) an array of SmallDocumentBlock instances, filled from the array

fill out a List of SmallDocumentBlocks so that it fully occupies a Set of big blocks

the List to be filled out. number of big blocks the list encompasses

Factory for creating SmallDocumentBlocks from DocumentBlocks

the original DocumentBlocks the total document size an array of new SmallDocumentBlocks instances

create a list of SmallDocumentBlock's from raw data

the raw data containing the SmallDocumentBlock a List of SmallDocumentBlock's extracted from the input

Read data from an array of SmallDocumentBlocks

the blocks to Read from. the buffer to Write the data into. the offset into the array of blocks to Read from

Calculate the storage size of a Set of SmallDocumentBlocks

number of SmallDocumentBlocks total size

Makes the empty small document block.

Converts to block count.

The size.

Write the storage to an OutputStream

the OutputStream to which the stored data should be written

Get the data from the block

the block's data as a byte array

A big block created from an InputStream, holding the raw data @author Marc Johnson (mjohnson at apache dot org

Constructor RawDataBlock

the Stream from which the data will be read

Initializes a new instance of the class.

the Stream from which the data will be read the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}

When we read the data, did we hit end of file?

true if the EoF was hit during this block, or; otherwise, falseif not. If you have a dodgy short last block, then it's possible to both have data, and also hit EoF...

Did we actually find any data to read? It's possible, in the event of a short last block, to both have hit the EoF, but also to have data

true if this instance has data; otherwise, false.

Get the data from the block

the block's data as a byte array

Abstract implementation of Entry Extending classes should override isDocument() or isDirectory(), as appropriate Extending classes must override isDeleteOK() @author Marc Johnson (mjohnson at apache dot org)

This interface provides access to an object managed by a Filesystem instance. Entry objects are further divided into DocumentEntry and DirectoryEntry instances. @author Marc Johnson (mjohnson at apache dot org)

Delete this Entry. ThIs operation should succeed, but there are special circumstances when it will not: If this Entry Is the root of the Entry tree, it cannot be deleted, as there Is no way to Create another one. If this Entry Is a directory, it cannot be deleted unless it Is empty.

true if the Entry was successfully deleted, else false

Rename this Entry. ThIs operation will fail if: There Is a sibling Entry (i.e., an Entry whose parent Is the same as this Entry's parent) with the same name. ThIs Entry Is the root of the Entry tree. Its name Is dictated by the Filesystem and many not be Changed.

the new name for this Entry true if the operation succeeded, else false

Get the name of the Entry

The name.

Is this a DirectoryEntry?

true if the Entry Is a DirectoryEntry; otherwise, false.

Is this a DocumentEntry?

true if the Entry Is a DocumentEntry; otherwise, false.

Create a DocumentNode. ThIs method Is not public by design; it Is intended strictly for the internal use of extending classes

the Property for this Entry the parent of this entry

Delete this Entry. ThIs operation should succeed, but there are special circumstances when it will not: If this Entry Is the root of the Entry tree, it cannot be deleted, as there Is no way to Create another one. If this Entry Is a directory, it cannot be deleted unless it Is empty.

true if the Entry was successfully deleted, else false

Rename this Entry. ThIs operation will fail if: There Is a sibling Entry (i.e., an Entry whose parent Is the same as this Entry's parent) with the same name. ThIs Entry Is the root of the Entry tree. Its name Is dictated by the Filesystem and many not be Changed.

the new name for this Entry true if the operation succeeded, else false

grant access to the property

the property backing this entry

Is this the root of the tree?

true if this instance is root; otherwise, false.

extensions use this method to verify internal rules regarding deletion of the underlying store.

true if it's ok to Delete the underlying store; otherwise, false.

Get the name of the Entry

The name. Get the name of the Entry @return name

Is this a DirectoryEntry?

true if the Entry Is a DirectoryEntry; otherwise, false.

Is this a DocumentEntry?

true if the Entry Is a DocumentEntry; otherwise, false.

Get this Entry's parent (the DocumentEntry that owns this Entry). All Entry objects, except the root Entry, has a parent.

this Entry's parent; null iff this Is the root Entry

Class POIFSDocumentPath @author Marc Johnson (mjohnson at apache dot org)

simple constructor for the path of a document that is in the root of the POIFSFileSystem. The constructor that takes an array of Strings can also be used to create such a POIFSDocumentPath by passing it a null or empty String array

constructor for the path of a document that is not in the root of the POIFSFileSystem

the Strings making up the path to a document. The Strings must be ordered as they appear in the directory hierarchy of the the document -- the first string must be the name of a directory in the root of the POIFSFileSystem, and every Nth (for N > 1) string thereafter must be the name of a directory in the directory identified by the (N-1)th string. If the components parameter is null or has zero length, the POIFSDocumentPath is appropriate for a document that is in the root of a POIFSFileSystem

constructor that adds additional subdirectories to an existing path

the existing path the additional subdirectory names to be added

equality. Two POIFSDocumentPath instances are equal if they have the same number of component Strings, and if each component String is equal to its coresponding component String

the object we're checking equality for true if the object is equal to this object

get the specified component

which component (0 ... length() - 1) the nth component;

Serves as a hash function for a particular type.

A hash code for the current .

Returns a that represents the current .

A that represents the current .

Gets the length.

the number of components

Returns the path's parent or null if this path is the root path.

path of parent, or null if this path is the root path

Initializes a new instance of the class.

index number byte data offset into byte data

Gets or sets the size of the document associated with this Property

the size of the document, in bytes

This interface defines methods specific to Document objects managed by a Filesystem instance. @author Marc Johnson (mjohnson at apache dot org)

get the size of the document, in bytes

size in bytes

Simple implementation of DocumentEntry @author Marc Johnson (mjohnson at apache dot org)

create a DocumentNode. This method Is not public by design; it Is intended strictly for the internal use of this package @param property the DocumentProperty for this DocumentEntry @param parent the parent of this entry get the POIFSDocument @return the internal POIFSDocument get the zize of the document, in bytes @return size in bytes Is this a DocumentEntry? @return true if the Entry Is a DocumentEntry, else false extensions use this method to verify internal rules regarding deletion of the underlying store. @return true if it's ok to delete the underlying store, else false Get an array of objects, some of which may implement POIFSViewable @return an array of Object; may not be null, but may be empty Get an Iterator of objects, some of which may implement POIFSViewable @return an Iterator; may not be null, but may have an empty back end store Give viewers a hint as to whether to call getViewableArray or getViewableIterator @return true if a viewer should call getViewableArray, false if a viewer should call getViewableIterator Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents. @return short description

Simple implementation of DirectoryEntry @author Marc Johnson (mjohnson at apache dot org)

This interface defines methods specific to Directory objects managed by a Filesystem instance. @author Marc Johnson (mjohnson at apache dot org)

get a specified Entry by name

the name of the Entry to obtain. the specified Entry, if it is directly contained in this DirectoryEntry

Create a new DocumentEntry

the name of the new DocumentEntry the Stream from which to Create the new DocumentEntry the new DocumentEntry

Create a new DocumentEntry; the data will be provided later

the name of the new DocumentEntry the size of the new DocumentEntry the new DocumentEntry

Create a new DocumentEntry; the data will be provided later

the name of the new DocumentEntry the size of the new DocumentEntry BeforeWriting event handler the new DocumentEntry

Create a new DirectoryEntry

the name of the new DirectoryEntry the name of the new DirectoryEntry

get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.)

The entries.never null, but hasNext() may return false immediately (i.e., this DirectoryEntry is empty). All objects retrieved by next() are guaranteed to be implementations of Entry.

is this DirectoryEntry empty?

true if this instance contains no Entry instances; otherwise, false.

find out how many Entry instances are contained directly within this DirectoryEntry

number of immediately (no grandchildren etc.) contained Entry instances

Gets or sets the storage ClassID.

The storage ClassID.

Create a DirectoryNode. This method Is not public by design; it Is intended strictly for the internal use of this package

the DirectoryProperty for this DirectoryEntry the POIFSFileSystem we belong to the parent of this entry

open a document in the directory's entry's list of entries

the name of the document to be opened a newly opened DocumentStream

Create a new DocumentEntry

the new document the new DocumentEntry

Change a contained Entry's name

the original name the new name true if the operation succeeded, else false

Deletes the entry.

the EntryNode to be Deleted true if the entry was Deleted, else false

get a specified Entry by name

the name of the Entry to obtain. the specified Entry, if it is directly contained in this DirectoryEntry

Create a new DocumentEntry

the name of the new DocumentEntry the Stream from which to Create the new DocumentEntry the new DocumentEntry

Create a new DocumentEntry; the data will be provided later

the name of the new DocumentEntry the size of the new DocumentEntry the new DocumentEntry

Create a new DocumentEntry; the data will be provided later

the name of the new DocumentEntry the size of the new DocumentEntry the new DocumentEntry

Create a new DirectoryEntry

the name of the new DirectoryEntry the name of the new DirectoryEntry

Gets the path.

this directory's path representation

get an iterator of the Entry instances contained directly in this instance (in other words, children only; no grandchildren etc.)

The entries.never null, but hasNext() may return false immediately (i.e., this DirectoryEntry is empty). All objects retrieved by next() are guaranteed to be implementations of Entry.

is this DirectoryEntry empty?

true if this instance contains no Entry instances; otherwise, false.

find out how many Entry instances are contained directly within this DirectoryEntry

number of immediately (no grandchildren etc.) contained Entry instances

Gets or Sets the storage clsid for the directory entry

The storage ClassID.

Is this a DirectoryEntry?

true if the Entry Is a DirectoryEntry, else false

extensions use this method to verify internal rules regarding deletion of the underlying store.

true if it's ok to Delete the underlying store, else false

Get an array of objects, some of which may implement POIFSViewable

an array of Object; may not be null, but may be empty

Get an Iterator of objects, some of which may implement POIFSViewable

an Iterator; may not be null, but may have an empty back end store

Give viewers a hint as to whether to call GetViewableArray or GetViewableIterator

true if a viewer should call GetViewableArray; otherwise, falseif a viewer should call GetViewableIterator

Provides a short description of the object, to be used when a POIFSViewable object has not provided its contents.

The short description.

Constants used by Properties namespace

Constants used in reading/writing the Header block @author Marc Johnson (mjohnson at apache dot org)

Class DocumentDescriptor @author Marc Johnson (mjohnson at apache dot org)

Initializes a new instance of the class.

the Document path the Document name

equality. Two DocumentDescriptor instances are equal if they have equal paths and names

the object we're checking equality for true if the object is equal to this object

Serves as a hash function for a particular type.

hashcode

Returns a that represents the current .

A that represents the current .

Gets the path.

The path.

Gets the name.

The name.

A list of RawDataBlocks instances, and methods to manage the list @author Marc Johnson (mjohnson at apache dot org

Initializes a new instance of the class.

the InputStream from which the data will be read The big block size, either 512 bytes or 4096 bytes

A repository for constants shared by POI classes. @author Marc Johnson (mjohnson at apache dot org)

Most files use 512 bytes as their big block size Most files use 512 bytes as their big block size Some use 4096 bytes

A block of block allocation table entries. BATBlocks are created only through a static factory method: createBATBlocks. @author Marc Johnson (mjohnson at apache dot org)

Create a single instance initialized with default values

Create an array of BATBlocks from an array of int block allocation table entries

the array of int entries the newly created array of BATBlocks

Create an array of XBATBlocks from an array of int block allocation table entries

the array of int entries the start block of the array of XBAT blocks the newly created array of BATBlocks

Calculate how many BATBlocks are needed to hold a specified number of BAT entries.

the number of entries the number of BATBlocks needed

Calculate how many XBATBlocks are needed to hold a specified number of BAT entries.

the number of entries the number of XBATBlocks needed

Write the block's data to an Stream

the Stream to which the stored data should be written

Gets the entries per block.

The number of entries per block

Gets the entries per XBAT block.

number of entries per XBAT block

Gets the XBAT chain offset.

offset of chain index of XBAT block

This class manages a document in the POIFS filesystem. @author Marc Johnson (mjohnson at apache dot org)

Initializes a new instance of the class.

the name of the POIFSDocument the InputStream we read data from

Constructor from small blocks

the name of the POIFSDocument the small blocks making up the POIFSDocument the actual length of the POIFSDocument

Constructor from large blocks

the name of the POIFSDocument the big blocks making up the POIFSDocument the actual length of the POIFSDocument

Constructor from small blocks

the name of the POIFSDocument Tthe small blocks making up the POIFSDocument the actual length of the POIFSDocument

Initializes a new instance of the class.

the name of the POIFSDocument the length of the POIFSDocument the path of the POIFSDocument

read data from the internal stores

the buffer to write to the offset into our storage to read from

Writes the blocks.

The stream.

Occurs when [before writing].

Gets the number of BigBlock's this instance uses

count of BigBlock instances

Gets the document property.

The document property.

Provides a short description of the object to be used when a POIFSViewable object has not provided its contents.

true if [prefer array]; otherwise, false.

Gets the short description.

The short description.

Gets the size.

The size.

Gets the small blocks.

The small blocks.

Sets the start block for this instance

index into the array of BigBlock instances making up the the filesystem

Get an array of objects, some of which may implement POIFSViewable

The viewable array.

Give viewers a hint as to whether to call ViewableArray or ViewableIterator

The viewable iterator.

EventArgs for POIFSReader author: Tony Qu

An event-driven Reader for POIFS file systems. Users of this class first Create an instance of it, then use the RegisterListener methods to Register POIFSReaderListener instances for specific documents. Once all the listeners have been Registered, the Read() method is called, which results in the listeners being notified as their documents are Read. @author Marc Johnson (mjohnson at apache dot org)

Initializes a new instance of the class.

Read from an InputStream and Process the documents we Get

the InputStream from which to Read the data POIFSDocument list

Processes the properties.

The small_blocks. The big_blocks. The properties. The path.

create a document block from a raw data block

The block.

Create a single instance initialized with data.

the InputStream delivering the data.

Create a single instance initialized with default values

convert a single long array into an array of DocumentBlock instances

the byte array to be converted the intended size of the array (which may be smaller) an array of DocumentBlock instances, filled from the input array

Read data from an array of DocumentBlocks

the blocks to Read from the buffer to Write the data into the offset into the array of blocks to Read from

Write the storage to an OutputStream

the OutputStream to which the stored data should be written

Get the number of bytes Read for this block.

bytes Read into the block

Gets the fill byte used

The fill byte.

Convert raw data blocks to an array of Property's

The blocks to be converted the converted List of Property objects. May contain nulls, but will not be null

Trivial extension of Property for POIFSDocuments @author Marc Johnson (mjohnson at apache dot org)

Initializes a new instance of the class.

POIFSDocument name POIFSDocument size

Initializes a new instance of the class.

index number byte data offset into byte data

Perform whatever activities need to be performed prior to writing

Gets or sets the document.

the associated POIFSDocument

Determines whether this instance is directory.

true if this instance is directory; otherwise, false.

This exception is thrown when we try to open a file that's actually an Office 2007+ XML file, rather than an OLE2 file (which is what POI works with) @author Nick Burch

This class contains methods used to inspect POIFSViewable objects @author Marc Johnson (mjohnson at apache dot org)

Inspect an object that may be viewable, and drill down if told to

the object to be viewed if true and the object implements POIFSViewable, inspect the objects' contents how far in to indent each string string to use for indenting a List of Strings holding the content

Indents the specified indent level.

how far in to indent each string string to use for indenting The data.

This class provides a wrapper over an OutputStream so that Document writers can't accidently go over their size limits @author Marc Johnson (mjohnson at apache dot org)

Create a POIFSDocumentWriter

the OutputStream to which the data is actually the maximum number of bytes that can be written

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Flushes this output stream and forces any buffered output bytes to be written out.

Writes b.length bytes from the specified byte array to this output stream.

the data.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

the data. the start offset in the data. the number of bytes to write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

the byte.

write the rest of the document's data (fill in at the end)

the actual number of bytes the corresponding document must fill the byte to fill remaining space with

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

true if the stream supports reading; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

true if the stream supports seeking; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

true if the stream supports writing; otherwise, false.

When overridden in a derived class, gets the length in bytes of the stream.

A long value representing the length of the stream in bytes. A class derived from Stream does not support seeking. Methods were called after the stream was closed.

When overridden in a derived class, gets or sets the position within the current stream.

The current position within the stream. An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed.

This class provides methods to read a DocumentEntry managed by a Filesystem instance. @author Marc Johnson (mjohnson at apache dot org)

Create an InputStream from the specified DocumentEntry

the DocumentEntry to be read

Create an InputStream from the specified Document

the Document to be read

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.

Reads some number of bytes from the input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. The definition of this method in java.io.InputStream allows this method to block, but it won't. If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected. If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed. The read(b) method for class InputStream has the same effect as:

the buffer into which the data is read. the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer. The definition of this method in java.io.InputStream allows it to block, but it won't. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected. In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected. If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.

the buffer into which the data is read. the start offset in array b at which the data is written. the maximum number of bytes to read. the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. The definition of this method in java.io.InputStream allows this method to block, but it won't.

the next byte of data, or -1 if the end of the stream is reached.

When overridden in a derived class, sets the position within the current stream.

A byte offset relative to the parameter. A value of type indicating the reference point used to obtain the new position. The new position within the current stream. An I/O error occurs. The stream does not support seeking, such as if the stream is constructed from a pipe or console output. Methods were called after the stream was closed.

Skips the specified n.

The n.

When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

An array of bytes. This method copies bytes from to the current stream. The zero-based byte offset in at which to begin copying bytes to the current stream. The number of bytes to be written to the current stream. The sum of and is greater than the buffer length. is null. or is negative. An I/O error occurs. The stream does not support writing. Methods were called after the stream was closed.

at the end Of document.

Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or or another thread.

the number of bytes that can be read from this input stream without blocking.

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

true if the stream supports reading; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

true if the stream supports seeking; otherwise, false.

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

true if the stream supports writing; otherwise, false.

When overridden in a derived class, gets the length in bytes of the stream.

A long value representing the length of the stream in bytes. A class derived from Stream does not support seeking. Methods were called after the stream was closed.

When overridden in a derived class, gets or sets the position within the current stream.

The current position within the stream. An I/O error occurs. The stream does not support seeking. Methods were called after the stream was closed.