org.zkoss.poi.hwpf.model

Class RevisionMarkAuthorTable

java.lang.Object

org.zkoss.poi.hwpf.model.RevisionMarkAuthorTable

@Internal
public final class RevisionMarkAuthorTable
extends Object

String table containing the names of authors of revision marks, e-mails and comments in this document.

Author:

Ryan Lauck

Constructor Summary

Constructors

Constructor and Description
RevisionMarkAuthorTable(byte[] tableStream, int offset, int size) Constructor to read the table from the table stream.

Method Summary

Modifier and Type	Method and Description
String	getAuthor(int index) Get an author by its index.
List<String>	getEntries() Gets the entries.
int	getSize() Gets the number of entries.
void	writeTo(HWPFOutputStream tableStream) Writes this table to the table stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RevisionMarkAuthorTable

public RevisionMarkAuthorTable(byte[] tableStream,
                               int offset,
                               int size)
                        throws IOException

Constructor to read the table from the table stream.

Parameters:

tableStream - the table stream.

offset - the offset into the byte array.

size - the size of the table in the byte array.

Throws:

IOException

Method Detail

getEntries

public List<String> getEntries()

Gets the entries. The returned list cannot be modified.

Returns:

the list of entries.

getAuthor

public String getAuthor(int index)

Get an author by its index. Returns null if it does not exist.

Returns:

the revision mark author

getSize

public int getSize()

Gets the number of entries.

Returns:

the number of entries.

writeTo

public void writeTo(HWPFOutputStream tableStream)
             throws IOException

Writes this table to the table stream.

Parameters:

tableStream - the table stream to write to.

Throws:

IOException - if an error occurs while writing.