util.Integer.clearBit

Returns the INTEGER parameter with the bit at the designated position set to 0.

Syntax

util.Integer.clearBit(
  i INTEGER,
  n SMALLINT
 )
  RETURNS INTEGER
  1. i is the integer value to modify.
  2. n is the bit position (LSB is at position zero).

Usage

The util.Integer.clearBit() method modifies the integer value by clearing the bit at the position passed as second parameter.

Note:
The position of the least significant bit (LSB) is the position zero:
  • In 00000001 (integer 1), the bit set to 1 is at position 0.
  • In 00100010 (integer 34), the bits set to 1 are at position 1 and 5.
Note:
Bitwise methods provided by the util.Integer class are based on the INTEGER type. Consider the following facts when using these methods:
  1. The INTEGER type is a four-byte signed integer: If the bit at position 31 is set to 1, the corresponding INTEGER value will be negative. Thus, util.Integer.not(0) produces the INTEGER value -1 (11111111 11111111 11111111 11111111).
  2. The NULL value for the INTEGER type is represented internally with the value 0x80000000 (10000000 00000000 00000000 00000000). When NULL is used with the util.Integer bitwise methods, it will be interpreted as 0x80000000 instead of a null value. However, if the result of the bitwise operation produces the value 0x80000000, it will be interpreted as NULL when used in an expression.

Example

IMPORT util
MAIN
    DISPLAY util.Integer.clearBit( 34, 5 ) -- displays 2
END MAIN