org.xbup.io.declaration

Class XBDBlockDecl

java.lang.Object

org.xbup.io.declaration.XBDBlockDecl

All Implemented Interfaces:

XBBlockDecl, XBTSerializable

public class XBDBlockDecl
extends java.lang.Object
implements XBBlockDecl, XBTSerializable

XBUP Level 1 Block Declaration using existing block definition.

Version:

0.1 wr21.0 2011/12/02

Author:

XBUP Project (http://xbup.org)

Constructor Summary

Constructors

Constructor and Description
XBDBlockDecl() Creates a new instance of XBBlockDecl
XBDBlockDecl(XBBlockDef blockDef)
XBDBlockDecl(XBBlockDef blockDef, int revision)
XBDBlockDecl(XBBlockDef blockDef, UBNatural revision)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) TODO: Include definition
XBBlockDef	getBlockDef()
int	getBlocksLimit()
XBTBlock	getParameter(XBTBlock block, int index) Get n-th parameter of the given block.
int	getParametersCount(XBTBlock block) Get count of parameters defined in given block.
XBParamPosition	getParamPosition(XBTConversible source, int index) Get n-th parameter of the given block.
int	getRevision()
XBTSerialMethod	getXBTSerializationMethod() Serialization method serialization from and to XBUP level 0 protocol.
int	hashCode()
boolean	matchType(XBBlockType type)
void	setBlockDef(XBBlockDef blockDef)
void	setBlocksLimit(int blocksLimit)
void	setParameter(XBTEditableBlock block, int index, XBTBlock parameter) Set n-th parameter of the given block.
void	setRevision(int revision)

Methods inherited from class java.lang.Object

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

Constructor Detail

XBDBlockDecl

public XBDBlockDecl()

Creates a new instance of XBBlockDecl

XBDBlockDecl

public XBDBlockDecl(XBBlockDef blockDef,
            UBNatural revision)

XBDBlockDecl

public XBDBlockDecl(XBBlockDef blockDef,
            int revision)

XBDBlockDecl

public XBDBlockDecl(XBBlockDef blockDef)

Method Detail

matchType

public boolean matchType(XBBlockType type)

getRevision

public int getRevision()

Specified by:

getRevision in interface XBBlockDecl

Returns:

the revision

setRevision

public void setRevision(int revision)

Parameters:

revision - the revision to set

getBlocksLimit

public int getBlocksLimit()

Returns:

the blocksLimit

setBlocksLimit

public void setBlocksLimit(int blocksLimit)

Parameters:

blocksLimit - the blocksLimit to set

equals

public boolean equals(java.lang.Object obj)

TODO: Include definition

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getParamPosition

public XBParamPosition getParamPosition(XBTConversible source,
                               int index)

Get n-th parameter of the given block.

Parameters:

source - block to get parameter from

index - index of the requested parameter

Returns:

instance of block

getParameter

public XBTBlock getParameter(XBTBlock block,
                    int index)

Get n-th parameter of the given block.

Parameters:

block - block to get parameter from

index - index of the requested parameter

Returns:

instance of block

setParameter

public void setParameter(XBTEditableBlock block,
                int index,
                XBTBlock parameter)

Set n-th parameter of the given block.

Parameters:

block - block to modify parameter in

index - index of parameter to modify

parameter - parameter content

getParametersCount

public int getParametersCount(XBTBlock block)

Get count of parameters defined in given block.

Parameters:

block - block to get count of parameters from

Returns:

count of defined parameters

getBlockDef

public XBBlockDef getBlockDef()

Returns:

the blockDef

setBlockDef

public void setBlockDef(XBBlockDef blockDef)

Parameters:

blockDef - the blockDef to set

getXBTSerializationMethod

public XBTSerialMethod getXBTSerializationMethod()

Description copied from interface: XBTSerializable

Serialization method serialization from and to XBUP level 0 protocol.

Specified by:

getXBTSerializationMethod in interface XBTSerializable

Returns:

serialization method