io.warp10.script.functions

Class BINTO

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.BINTOx

io.warp10.script.functions.BINTO

All Implemented Interfaces:

WarpScriptStackFunction

public class BINTO
extends BINTOx

Decode a binary representation as a String to a byte array.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	generateResult(java.lang.Object data) Generate the final result given data structure, updated for each byte.
java.lang.Object	initData(int numberOfBits) Initialize the data structure which will be updated for each decoded byte.
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.functions.BINTOx

apply

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

BINTO

public BINTO(java.lang.String name)

Method Detail

initData

public java.lang.Object initData(int numberOfBits)

Description copied from class: BINTOx

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.

Specified by:

initData in class BINTOx

Parameters:

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

Returns:

A data structure.

updateData

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

Description copied from class: BINTOx

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

Specified by:

updateData in class BINTOx

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 java.lang.Object generateResult(java.lang.Object data)

Description copied from class: BINTOx

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

Specified by:

generateResult in class BINTOx

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.