org.xbup.io.tree

Interface XBDocument

All Known Subinterfaces:

XBEditableDocument

All Known Implementing Classes:

XBTreeDocument

public interface XBDocument

Basic interface for XBUP document level 0.

Version:

0.1 wr20.0 2010/09/26

Author:

XBUP Project (http://xbup.org)

Method Summary

Methods

Modifier and Type	Method and Description
long	getDocumentSize() Get size of the whole document.
java.io.InputStream	getExtended() Get extended data area.
long	getExtendedSize() Get size of extended data area.
XBBlock	getRootBlock() Get root block of the document.

Method Detail

getExtended

java.io.InputStream getExtended()

Get extended data area.

Returns:

InputStream of providing read access to data area.

getExtendedSize

long getExtendedSize()

Get size of extended data area.

Returns:

length of extended area in bytes.

getRootBlock

XBBlock getRootBlock()

Get root block of the document.

Returns:

root block if exits or null.

getDocumentSize

long getDocumentSize()

Get size of the whole document. It is sum of the size of the root node if present + size of the extended area.

Returns:

length of extended area in bytes.