org.ghost4j.document

Class AbstractDocument

java.lang.Object

org.ghost4j.document.AbstractDocument

All Implemented Interfaces:

Serializable, Document

Direct Known Subclasses:

PDFDocument, PSDocument

public abstract class AbstractDocument
extends Object
implements Document, Serializable

Abstract document implementation. Contains methods that are common to the different document types

Author:

Gilles Grousset (gi.grousset@gmail.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	content Content of the document.
static int	READ_BUFFER_SIZE Buffer size used while reading (loading) document content.

Fields inherited from interface org.ghost4j.document.Document

TYPE_PDF, TYPE_POSTSCRIPT

Constructor Summary

Constructors

Constructor and Description
AbstractDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	append(Document document) Append pages of another document to the current document.
protected void	assertValidPageIndex(int index) Assert the given page index is valid for the current document.
protected void	assertValidPageRange(int begin, int end) Assert the given page range is valid for the current document.
List<Document>	explode() Separate each pages to a new document.
byte[]	getContent() Return document content as a byte array
int	getSize() Return document size
void	load(File file) Load document from a File.
void	load(InputStream inputStream) Load document from an InputStream.
void	write(File file) Write document to a File.
void	write(OutputStream outputStream) Write document to an OutputStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ghost4j.document.Document

extract, getPageCount, getType

Field Detail

READ_BUFFER_SIZE

public static final int READ_BUFFER_SIZE

Buffer size used while reading (loading) document content.

See Also:

Constant Field Values

content

protected byte[] content

Content of the document.

Constructor Detail

AbstractDocument

public AbstractDocument()

Method Detail

load

public void load(File file)
          throws FileNotFoundException,
                 IOException

Description copied from interface: Document

Load document from a File.

Specified by:

load in interface Document

Parameters:

file - File.

Throws:

FileNotFoundException

IOException

load

public void load(InputStream inputStream)
          throws IOException

Description copied from interface: Document

Load document from an InputStream.

Specified by:

load in interface Document

Throws:

IOException

write

public void write(File file)
           throws IOException

Description copied from interface: Document

Write document to a File.

Specified by:

write in interface Document

Parameters:

file - File.

Throws:

IOException

write

public void write(OutputStream outputStream)
           throws IOException

Description copied from interface: Document

Write document to an OutputStream

Specified by:

write in interface Document

Throws:

IOException

getSize

public int getSize()

Description copied from interface: Document

Return document size

Specified by:

getSize in interface Document

Returns:

Document size in bytes.

getContent

public byte[] getContent()

Description copied from interface: Document

Return document content as a byte array

Specified by:

getContent in interface Document

Returns:

Byte array

assertValidPageIndex

protected void assertValidPageIndex(int index)
                             throws DocumentException

Assert the given page index is valid for the current document.

Parameters:

index - Index to check

Throws:

DocumentException - Thrown if index is not valid

assertValidPageRange

protected void assertValidPageRange(int begin,
                        int end)
                             throws DocumentException

Assert the given page range is valid for the current document.

Parameters:

begin - Range begin index

end - Range end index

Throws:

DocumentException

append

public void append(Document document)
            throws DocumentException

Description copied from interface: Document

Append pages of another document to the current document.

Specified by:

append in interface Document

Parameters:

document - Document ot append

Throws:

DocumentException

explode

public List<Document> explode()
                       throws DocumentException

Description copied from interface: Document

Separate each pages to a new document.

Specified by:

explode in interface Document

Returns:

A list of Document.

Throws:

DocumentException