Skip to main content
Pentaho Documentation

BitSet

pentaho.util.BitSet

Extends

Constructor

Name Description
new BitSet(bits)

Creates a bit set instance.

Members

Name Description
base : function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

isEmpty : boolean

Gets a value that indicates if there are no bits set.

Methods

Name Description
clear(mask)

Clears the given bits.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

get() : number

Gets an integer number with the bits currently set.

is(mask) : boolean

Returns a value that indicates if the current state is equal to a given mask.

isSubsetOf(mask) : boolean

Returns a value that indicates if the current state is a subset of a given mask.

set(mask)

Sets on the given bits.

Constructor Details

new BitSet(bits)

Creates a bit set instance.

Source: javascript/web/pentaho/util/BitSet.js, line 26

Parameters:
Name Default Value Summary
bits : number
 
Optional

The bits to be set, initially. Defaults to no bits.

Members Details

base: function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

Can also be called from within a constructor function.

Source: javascript/web/pentaho/lang/Base.js, line 265

Inherited From: pentaho.lang.Base#base

isEmpty: boolean

Gets a value that indicates if there are no bits set.

Source: javascript/web/pentaho/util/BitSet.js, line 36

Methods Details

clear(mask)

Clears the given bits.

Source: javascript/web/pentaho/util/BitSet.js, line 74

Parameters:
Name Default Value Summary
mask : number
 
Optional

The bits to be cleared. Defaults to all bits.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Can be applied to non-Base instances (e.g. using Base.prototype.extend.call(alien, {a: "hello"})).

Source: javascript/web/pentaho/lang/Base.js, line 808

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : Object

The instance specification.

keyArgs : Object
 
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : Object
 
Optional

A map of property names to exclude from source.

Returns:
Name Description
Object

This object.

get() : number

Gets an integer number with the bits currently set.

Source: javascript/web/pentaho/util/BitSet.js, line 45

Returns:
Name Description
number

The internal bits as a number.

is(mask) : boolean

Returns a value that indicates if the current state is equal to a given mask.

Source: javascript/web/pentaho/util/BitSet.js, line 56

Parameters:
Name Default Value Summary
mask : number

An integer containing the bit mask to test.

Returns:
Name Description
boolean

true when mask is equal to the current state; false otherwise.

isSubsetOf(mask) : boolean

Returns a value that indicates if the current state is a subset of a given mask.

Use this method to assert if no bits other than those described by the mask are currently set.

Source: javascript/web/pentaho/util/BitSet.js, line 87

Parameters:
Name Default Value Summary
mask : number

An integer containing the bit mask to test.

Returns:
Name Description
boolean

true if the bits currently set are within the specified mask; false otherwise.

set(mask)

Sets on the given bits.

Source: javascript/web/pentaho/util/BitSet.js, line 65

Parameters:
Name Default Value Summary
mask : number
 
Optional

The bits to be set. Defaults to all bits.