io.warp10.script.functions

Class BINTOx

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.BINTOx

All Implemented Interfaces:

WarpScriptStackFunction

Direct Known Subclasses:

BINTO, BINTOHEX

public abstract class BINTOx
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Parent class to decode a binary representation as a String into a sequence of bytes. What to do with each byte is left to the subclass. For instance: 0000100001100001 is split into 00001000 01100001 which will generate the byte sequence 8, 97. If the representation is not a multiple of 8, the representation is left-padded with zeros. For instance: 10011110000 will be interpreted as 0000010011110000, generating 4, 240

Constructor Summary

Constructors

Constructor and Description
BINTOx(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
abstract java.lang.Object	generateResult(java.lang.Object data) Generate the final result given data structure, updated for each byte.
abstract java.lang.Object	initData(int numberOfBits) Initialize the data structure which will be updated for each decoded byte.
abstract void	updateData(java.lang.Object data, int byteIndex, byte currentByte) Update the data structure for a given byte at given byte index.

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BINTOx

public BINTOx(java.lang.String name)

Method Detail

apply

public java.lang.Object apply(WarpScriptStack stack)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

initData

public abstract java.lang.Object initData(int numberOfBits)

Initialize the data structure which will be updated for each decoded byte. It can be any Object as the responsibility of updating this Object also falls on the subclass.

Parameters:

numberOfBits - The number of bits in the binary representation which is always a multiple of 8.

Returns:

A data structure.

updateData

public abstract void updateData(java.lang.Object data,
                                int byteIndex,
                                byte currentByte)

Update the data structure for a given byte at given byte index.

Parameters:

data - The data structure to be updated.

byteIndex - The index of the byte to update.

currentByte - The value of the decoded byte.

generateResult

public abstract java.lang.Object generateResult(java.lang.Object data)

Generate the final result given data structure, updated for each byte.

Parameters:

data - The initialized and updated data structure.

Returns:

Any Object to be put on the stack as a result of a call to this function.