org.xbup.lib.core.block

Class XBTEmptyBlock

java.lang.Object

org.xbup.lib.core.block.XBTEmptyBlock

All Implemented Interfaces:

XBTBlock, XBPSequenceSerializable, XBSerializable

public class XBTEmptyBlock
extends java.lang.Object
implements XBTBlock, XBPSequenceSerializable

Interface for read access to XBUP level 1 block.

Constructor Summary

Constructors

Constructor and Description
XBTEmptyBlock()

Method Summary

Modifier and Type	Method and Description
UBNatural	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.
static XBTEmptyBlock	getEmptyBlock()
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.
void	serializeXB(XBPSequenceSerialHandler serializationHandler) Performs dual-way serialization to XBUP protocol.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XBTEmptyBlock

public XBTEmptyBlock()

Method Detail

getParent

public XBTBlock getParent()

Description copied from interface: XBTBlock

Gets parent block or null if block has no parent.

Specified by:

getParent in interface XBTBlock

Returns:

parent block

getTerminationMode

public XBBlockTerminationMode getTerminationMode()

Description copied from interface: XBTBlock

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

Specified by:

getTerminationMode in interface XBTBlock

Returns:

terminated mode

getDataMode

public XBBlockDataMode getDataMode()

Description copied from interface: XBTBlock

Returns whether this block is data block.

Specified by:

getDataMode in interface XBTBlock

Returns:

data mode

getBlockType

public XBBlockType getBlockType()

Description copied from interface: XBTBlock

Gets block type.

Specified by:

getBlockType in interface XBTBlock

Returns:

block type

getAttributes

public XBAttribute[] getAttributes()

Description copied from interface: XBTBlock

Gets array of attributes in order of appearance.

Specified by:

getAttributes in interface XBTBlock

Returns:

array of attributes

getAttributeAt

public UBNatural getAttributeAt(int attributeIndex)

Description copied from interface: XBTBlock

Gets attribute of given index. Returns zero if attribute index greater than attributes count.

Specified by:

getAttributeAt in interface XBTBlock

Parameters:

attributeIndex - index of attribute

Returns:

attribute value

getAttributesCount

public int getAttributesCount()

Description copied from interface: XBTBlock

Gets count of attributes.

Specified by:

getAttributesCount in interface XBTBlock

Returns:

count of attributes

getChildren

public XBTBlock[] getChildren()

Description copied from interface: XBTBlock

Gets array of all children.

Specified by:

getChildren in interface XBTBlock

Returns:

array of child blocks

getChildAt

public XBTBlock getChildAt(int childIndex)

Description copied from interface: XBTBlock

Gets children of given index.

Specified by:

getChildAt in interface XBTBlock

Parameters:

childIndex - index of child block

Returns:

child block

getChildrenCount

public int getChildrenCount()

Description copied from interface: XBTBlock

Gets count of children blocks.

Specified by:

getChildrenCount in interface XBTBlock

Returns:

count of children

getData

public java.io.InputStream getData()

Description copied from interface: XBTBlock

Gets block data.

Specified by:

getData in interface XBTBlock

Returns:

data stream

getBlockData

public XBBlockData getBlockData()

Description copied from interface: XBTBlock

Gets block data.

Specified by:

getBlockData in interface XBTBlock

Returns:

block data or null

getDataSize

public long getDataSize()

Description copied from interface: XBTBlock

Gets data size.

Specified by:

getDataSize in interface XBTBlock

Returns:

data size in bytes

getBlockIndex

public int getBlockIndex()

Description copied from interface: XBTBlock

Gets block position in tree in depth-first scan.

Specified by:

getBlockIndex in interface XBTBlock

Returns:

position index

getBlockSize

public long getBlockSize()

Description copied from interface: XBTBlock

Gets block size.

Specified by:

getBlockSize in interface XBTBlock

Returns:

block size in bytes.

getEmptyBlock

public static XBTEmptyBlock getEmptyBlock()

serializeXB

public void serializeXB(XBPSequenceSerialHandler serializationHandler)
                 throws XBProcessingException,
                        java.io.IOException

Description copied from interface: XBPSequenceSerializable

Performs dual-way serialization to XBUP protocol.

Specified by:

serializeXB in interface XBPSequenceSerializable

Parameters:

serializationHandler - serialization resource

Throws:

XBProcessingException - if proccesing problem encountered

java.io.IOException - if input/output problem encountered