gov.nih.nlm.nls.lvg.Lib

Class BitMaskOpt

java.lang.Object

gov.nih.nlm.nls.lvg.Lib.BitMaskOpt

public class BitMaskOpt
extends java.lang.Object

This class is the base class for Bit Mask Option operation Using Integer. This class is similar to BitMaskBase (long) and is used for flow specific options. Child classes which inherit (extend) from this class need to: This class is used for inflection and category to get the unique value from the combination of each bit (pos)

1. declare bitStr_
2. define the correspond BIT

History:

Version:

V-2026

Author:

NLM NLS Development Team

See Also:

Design document

Field Summary

Fields

Modifier and Type	Field and Description
static int[]	MASK
static int	MAX_BIT the maximum number of bits used.
static java.lang.String	SP

Method Summary

Modifier and Type	Method and Description
static boolean	Contains(int container, int value) Check if a given container object contains a object with a given value.
static boolean	GetBitFlag(int value, int maskIndex) Get the bit value (true or false) at the specified index of this object
static java.lang.String	GetBitName(int bitIndex, java.util.ArrayList<java.lang.String> bitStr) Get the name at index order of a specified bit (single).
static java.lang.String	GetBitNames(int value, java.util.ArrayList<java.lang.String> bitStr) Get the combined bit string (abbreviation) of a specified value.
static int	GetBitValue(int bitIndex) Get the int value of mask at a specified bit.
static void	main(java.lang.String[] args) Test driver for this class
static int	UpdateValue(int inValue, java.util.ArrayList<java.lang.String> strList, java.lang.String name, boolean flag) Get the bit value by adding the specified name for this object
static int	UpdateValue(int inValue, int bitIndex, boolean flag) Get the bit value by adding the specified bit for this object

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BIT

public static final int MAX_BIT

the maximum number of bits used. It is used in it's child classes

See Also:

Constant Field Values

SP

public static final java.lang.String SP

See Also:

Constant Field Values

MASK

public static final int[] MASK

Method Detail

UpdateValue

public static int UpdateValue(int inValue,
                              int bitIndex,
                              boolean flag)

Get the bit value by adding the specified bit for this object

Parameters:

inValue - value of option

bitIndex - index of the bit to be set

flag - boolean value of the bit to be set (true or false).

Returns:

int value of option

UpdateValue

public static int UpdateValue(int inValue,
                              java.util.ArrayList<java.lang.String> strList,
                              java.lang.String name,
                              boolean flag)

Get the bit value by adding the specified name for this object

Parameters:

inValue - value of option

strList - the arraylist of option str

name - string of the option to be set.

flag - boolean value of the bit to be set (true or false).

Returns:

int value of option

GetBitName

public static java.lang.String GetBitName(int bitIndex,
                                          java.util.ArrayList<java.lang.String> bitStr)

Get the name at index order of a specified bit (single).

Parameters:

bitIndex - bit index for finding it's name

bitStr - an ArrayList of String - bitStr

Returns:

name at index order of the bit specified

GetBitNames

public static java.lang.String GetBitNames(int value,
                                           java.util.ArrayList<java.lang.String> bitStr)

Get the combined bit string (abbreviation) of a specified value.

Parameters:

value - number for finding it's combined name

bitStr - a Vector of String - bitStr

Returns:

name in a String format of an bitMask object

GetBitFlag

public static boolean GetBitFlag(int value,
                                 int maskIndex)

Get the bit value (true or false) at the specified index of this object

Parameters:

value - value of option

maskIndex - index of the bit to find it's boolean value

Returns:

boolean value (true or false) of the specified bit

GetBitValue

public static int GetBitValue(int bitIndex)

Get the int value of mask at a specified bit.

Parameters:

bitIndex - the bit index that is interested

Returns:

an int value of the mask at bit index

Contains

public static boolean Contains(int container,
                               int value)

Check if a given container object contains a object with a given value. Contain means all bits are true in the tested object are also true in the container object

Parameters:

container - a int value of the conatiner

value - a int value of the testing object

Returns:

true or false if this object contains or does not contain the object with the given value

main

public static void main(java.lang.String[] args)

Test driver for this class

Parameters:

args - arguments