org.ghost4j.document

Interface Document

All Known Implementing Classes:

AbstractDocument, PDFDocument, PSDocument

public interface Document

Interface defining a document that can be handled by the library.

Author:

Gilles Grousset (gi.grousset@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_PDF
static String	TYPE_POSTSCRIPT

Method Summary

Methods

Modifier and Type	Method and Description
void	append(Document document) Append pages of another document to the current document.
List<Document>	explode() Separate each pages to a new document.
Document	extract(int begin, int end) Return a new document containing pages of a given range.
byte[]	getContent() Return document content as a byte array
int	getPageCount() Return document page count
int	getSize() Return document size
String	getType() Return the type of the document.
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

Field Detail

TYPE_POSTSCRIPT

static final String TYPE_POSTSCRIPT

See Also:

Constant Field Values

TYPE_PDF

static final String TYPE_PDF

See Also:

Constant Field Values

Method Detail

load

void load(File file)
          throws FileNotFoundException,
                 IOException

Load document from a File.

Parameters:

file - File.

Throws:

FileNotFoundException

IOException

load

void load(InputStream inputStream)
          throws IOException

Load document from an InputStream.

Parameters:

inputStream -

Throws:

IOException

write

void write(File file)
           throws IOException

Write document to a File.

Parameters:

file - File.

Throws:

IOException

write

void write(OutputStream outputStream)
           throws IOException

Write document to an OutputStream

Parameters:

outputStream -

Throws:

IOException

getPageCount

int getPageCount()
                 throws DocumentException

Return document page count

Returns:

Number of pages.

Throws:

DocumentException

getType

String getType()

Return the type of the document.

Returns:

A String representing the document type name.

getSize

int getSize()

Return document size

Returns:

Document size in bytes.

getContent

byte[] getContent()

Return document content as a byte array

Returns:

Byte array

extract

Document extract(int begin,
               int end)
                 throws DocumentException

Return a new document containing pages of a given range. Note : begin and end indicies start at 1

Parameters:

begin - Index of the first page to extract

end - Index of the last page to extract

Returns:

A new document.

Throws:

DocumentException

append

void append(Document document)
            throws DocumentException

Append pages of another document to the current document.

Parameters:

document - Document ot append

Throws:

DocumentException

explode

List<Document> explode()
                       throws DocumentException

Separate each pages to a new document.

Returns:

A list of Document.

Throws:

DocumentException