org.xbup.lib.core.block

Interface XBTBlock

All Known Subinterfaces:

XBTEditableBlock

All Known Implementing Classes:

XBTDefaultBlock, XBTEmptyBlock

public interface XBTBlock

Interface for read access to XBUP level 1 block.

Method Summary

Modifier and Type	Method and Description
XBAttribute	getAttributeAt(int attributeIndex) Gets attribute of given index.
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.
XBBlockType	getBlockType() Gets block type.
java.io.InputStream	getData() Gets block data.
XBBlockDataMode	getDataMode() Returns whether this block is data block.
long	getDataSize() Gets data size.
XBTBlock	getChildAt(int childIndex) Gets children of given index.
XBTBlock[]	getChildren() Gets array of all children.
int	getChildrenCount() Gets count of children blocks.
XBTBlock	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

XBTBlock getParent()

Gets parent block or null if block has no parent.

Returns:

parent block

getTerminationMode

XBBlockTerminationMode getTerminationMode()

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

Returns:

terminated mode

getDataMode

XBBlockDataMode getDataMode()

Returns whether this block is data block.

Returns:

data mode

getBlockType

XBBlockType getBlockType()

Gets block type.

Returns:

block type

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. Returns zero if attribute index greater than attributes count.

Parameters:

attributeIndex - index of attribute

Returns:

attribute value

getAttributesCount

int getAttributesCount()

Gets count of attributes.

Returns:

count of attributes

getChildren

XBTBlock[] getChildren()

Gets array of all children.

Returns:

array of child blocks

getChildAt

XBTBlock getChildAt(int childIndex)

Gets children of given index.

Parameters:

childIndex - index of child block

Returns:

child block

getChildrenCount

int getChildrenCount()

Gets count of children blocks.

Returns:

count of children

getData

java.io.InputStream getData()

Gets block data.

Returns:

data stream

getBlockData

XBBlockData getBlockData()

Gets block data.

Returns:

block data or null

getDataSize

long getDataSize()

Gets data size.

Returns:

data size in bytes

getBlockIndex

int getBlockIndex()

Gets block position in tree in depth-first scan.

Returns:

position index

getBlockSize

long getBlockSize()

Gets block size.

Returns:

block size in bytes.