org.xbup.lib.core.block

Interface XBBlock

All Known Subinterfaces:

XBEditableBlock

All Known Implementing Classes:

XBDefaultBlock

public interface XBBlock

Interface for read access to XBUP level 0 block.

Method Summary

Modifier and Type	Method and Description
XBAttribute	getAttributeAt(int attributeIndex) Gets attribute of given index / order.
XBAttribute[]	getAttributes() Gets array of attributes in order of appearance.
int	getAttributesCount() Gets count of attributes.
XBBlockData	getBlockData() Gets block data.
int	getBlockIndex() Gets block position in tree in depth-first scan.
long	getBlockSize() Gets block size.
java.io.InputStream	getData() Gets block data.
XBBlockDataMode	getDataMode() Returns whether this block is data block.
long	getDataSize() Gets data size.
XBBlock	getChildAt(int childIndex) Gets child block of given index.
XBBlock[]	getChildren() Gets array of all children blocks.
int	getChildrenCount() Gets count of children.
XBBlock	getParent() Gets parent block or null if block has no parent.
XBBlockTerminationMode	getTerminationMode() Returns whether this block is using sequence of children ended with termination block.

Method Detail

getParent

XBBlock getParent()

Gets parent block or null if block has no parent.

Returns:

Parent block.

getDataMode

XBBlockDataMode getDataMode()

Returns whether this block is data block.

Returns:

data mode

getTerminationMode

XBBlockTerminationMode getTerminationMode()

Returns whether this block is using sequence of children ended with termination block.

Returns:

termination mode

getAttributes

XBAttribute[] getAttributes()

Gets array of attributes in order of appearance.

Returns:

array of attributes

getAttributeAt

XBAttribute getAttributeAt(int attributeIndex)

Gets attribute of given index / order.

Parameters:

attributeIndex - index/order of attribute

Returns:

attribute value

getAttributesCount

int getAttributesCount()

Gets count of attributes.

Returns:

count of attributes

getChildren

XBBlock[] getChildren()

Gets array of all children blocks.

Returns:

list of child blocks

getChildAt

XBBlock getChildAt(int childIndex)

Gets child block of given index.

Parameters:

childIndex - index of child block

Returns:

child block

getChildrenCount

int getChildrenCount()

Gets count of children.

Returns:

count of children

getData

java.io.InputStream getData()

Gets block data.

Returns:

block data or null

getBlockData

XBBlockData getBlockData()

Gets block data.

Returns:

block data or null

getDataSize

long getDataSize()

Gets data size.

Returns:

data size in bytes

getBlockSize

long getBlockSize()

Gets block size.

Returns:

block size in bytes

getBlockIndex

int getBlockIndex()

Gets block position in tree in depth-first scan.

Returns:

position index