usr.logging

Class BitMask

java.lang.Object

usr.logging.BitMask

All Implemented Interfaces:

java.lang.Cloneable

public class BitMask
extends java.lang.Object
implements java.lang.Cloneable

A BitMask object holds a bit mask. It has methods to get and set bits. It is similar to java.util.BitSet, but is less cumbersome. On the other hand it can only be 32 bits.

Constructor Summary

Constructors

Constructor and Description
BitMask() Construct a new BitMask with value of 0
BitMask(int m) Construct a BitMask from an integer

Method Summary

Methods

Modifier and Type	Method and Description
BitMask	and(BitMask mask) Performs a logical AND of this mask with the argument mask.
BitMask	clear() Sets all of the bits to 0 Returns this BitMask.
java.lang.Object	clone() Cloning a BitMask produces a new BitMask that is equal to it.
boolean	equals(java.lang.Object obj) Equals
int	hashCode() Hash Code.
BitMask	invert() Inverts all of the bits of this BitMask.
boolean	isClear() Is the mask clear? That is, is any bit set? Returns true if it is, false otherwise.
boolean	isSet(int bitIndex) Is the bit at the specified index set? Returns true if it is, false otherwise.
BitMask	or(BitMask mask) Performs a logical OR of this mask with the argument mask.
BitMask	set(int bitIndex) Sets the bit at the specified index.
java.lang.String	toString() To String
BitMask	unset(int bitIndex) Unsets the bit at the specified index.
BitMask	xor(BitMask mask) Performs a logical XOR of this mask with the argument mask.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BitMask

public BitMask()

Construct a new BitMask with value of 0

BitMask

public BitMask(int m)

Construct a BitMask from an integer

Method Detail

and

public BitMask and(BitMask mask)

Performs a logical AND of this mask with the argument mask. A new mask is returned so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the mask argument also had the value true.

or

public BitMask or(BitMask mask)

Performs a logical OR of this mask with the argument mask. A new mask is returned so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the mask argument has the value true.

xor

public BitMask xor(BitMask mask)

Performs a logical XOR of this mask with the argument mask. A new mask is returned so that a bit in it has the value true if and only if one of the following statements holds: The bit initially has the value true, and the corresponding bit in the argument has the value false. The bit initially has the value false, and the corresponding bit in the argument has the value true.

set

public BitMask set(int bitIndex)

Sets the bit at the specified index. Returns this BitMask.

unset

public BitMask unset(int bitIndex)

Unsets the bit at the specified index. Returns this BitMask.

isSet

public boolean isSet(int bitIndex)

Is the bit at the specified index set? Returns true if it is, false otherwise.

clear

public BitMask clear()

Sets all of the bits to 0 Returns this BitMask.

isClear

public boolean isClear()

Is the mask clear? That is, is any bit set? Returns true if it is, false otherwise.

invert

public BitMask invert()

Inverts all of the bits of this BitMask. Returns this BitMask.

clone

public java.lang.Object clone()

Cloning a BitMask produces a new BitMask that is equal to it. The clone of the bit set is another bit set that has exactly the same bits set to true as this mask.

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Equals

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Hash Code.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

To String

Overrides:

toString in class java.lang.Object