zserio.runtime

Class BuiltInOperators

java.lang.Object

zserio.runtime.BuiltInOperators

public final class BuiltInOperators
extends java.lang.Object

The implementation of all Zserio built-in operators called from code generated by Zserio.

Constructor Summary

Constructors

Constructor and Description
BuiltInOperators()

Method Summary

Modifier and Type	Method and Description
static boolean	isSet(ZserioBitmask bitmaskValue, ZserioBitmask requiredMask) Checks whether the requiredMask is set within the bitmaskValue.
static int	lengthOf(java.lang.String stringValue) Gets length of the given string in UTF-8 bytes.
static short	numBits(java.math.BigInteger numValues) Gets the minimum number of bits required to encode numValues different values.
static short	numBits(long numValues) Gets the minimum number of bits required to encode numValues different values.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuiltInOperators

public BuiltInOperators()

Method Detail

isSet

public static boolean isSet(ZserioBitmask bitmaskValue,
                            ZserioBitmask requiredMask)

Checks whether the requiredMask is set within the bitmaskValue.

This method implements Zserio built-in operator isset for Zserio bitmask types.

Example:

issset(bitmaskField, Bitmask.READ)

Parameters:

bitmaskValue - Bitmask value to check.

requiredMask - Mast to use.

Returns:

True when the required mask is set within the bitmaskValue, false otherwise.

numBits

public static short numBits(long numValues)

Gets the minimum number of bits required to encode numValues different values.

This method implements Zserio built-in operator numbits for Zserio uint8, uint16 and uint32 types.

Note: Please note that this method returns 0 if value is zero or negative value.

Examples:

numbits(0) = 0
numbits(1) = 1
numbits(2) = 1
numbits(3) = 2
numbits(4) = 2
numbits(8) = 3
numbits(16) = 4

Parameters:

numValues - The number of different values from which to calculate number of bits.

Returns:

Number of bis required to encode numValues different values.

numBits

public static short numBits(java.math.BigInteger numValues)

Gets the minimum number of bits required to encode numValues different values.

This method implements Zserio built-in operator numbits for Zserio uint64 type which is mapped to Java BigInteger type.

Examples:

numbits(0) = 0
numbits(1) = 1
numbits(2) = 1
numbits(3) = 2
numbits(4) = 2
numbits(8) = 3
numbits(16) = 4

Parameters:

numValues - The number of different values from which to calculate number of bits.

Returns:

Number of bis required to encode numValues different values.

lengthOf

public static int lengthOf(java.lang.String stringValue)

Gets length of the given string in UTF-8 bytes.

Parameters:

stringValue - String value.

Returns:

Number of bytes needed to encode given string in UTF-8.