XBDocument (xbup-core 0.2.1 API)

All Known Subinterfaces:

XBEditableDocument

All Known Implementing Classes:

XBDefaultDocument, XBDefaultEditableDocument
```
public interface XBDocument
```
Interface for read access to XBUP level 0 document.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getDocumentSize()`	Returns size of the whole document if available.
`java.util.Optional<XBBlock>`	`getRootBlock()`	Returns root block of the document.
`java.util.Optional<java.io.InputStream>`	`getTailData()`	Returns tail data input stream.
`long`	`getTailDataSize()`	Returns size of the tail data if available.

- Method Detail
  - getRootBlock
```
@Nonnull
java.util.Optional<XBBlock> getRootBlock()
```
    Returns root block of the document.
    
    Returns:
    
    root block if exits or null.
  - getDocumentSize
```
long getDocumentSize()
```
    Returns size of the whole document if available.
    
    Returns:
    
    length of whole document in bytes or -1 if not available or is infinite
  - getTailData
```
@Nonnull
java.util.Optional<java.io.InputStream> getTailData()
```
    Returns tail data input stream.
    
    Returns:
    
    InputStream of providing read access to data area
  - getTailDataSize
```
long getTailDataSize()
```
    Returns size of the tail data if available.
    
    Returns:
    
    length of tail data in bytes or -1 if not available or is infinite