Save This Page
Home » cocoon-2.1.11-src » org.apache.cocoon.poi » util » [javadoc | source]
org.apache.cocoon.poi.util
public class: BitField [javadoc | source]
java.lang.Object
   org.apache.cocoon.poi.util.BitField
Manage operations dealing with bit-mapped fields.
Constructor:
 public BitField(int mask) 
Method from org.apache.cocoon.poi.util.BitField Summary:
clear,   clearByte,   clearShort,   getRawValue,   getShortRawValue,   getShortValue,   getValue,   isAllSet,   isSet,   set,   setBoolean,   setByte,   setByteBoolean,   setShort,   setShortBoolean,   setShortValue,   setValue
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.poi.util.BitField Detail:
 public int clear(int holder) 
    Clear the bits.
 public byte clearByte(byte holder) 
    Clear the bits.
 public short clearShort(short holder) 
    Clear the bits.
 public int getRawValue(int holder) 
    Obtain the value for the specified BitField, unshifted
 public short getShortRawValue(short holder) 
    Obtain the value for the specified BitField, unshifted
 public short getShortValue(short holder) 
    Obtain the value for the specified BitField, appropriately shifted right, as a short. Many users of a BitField will want to treat the specified bits as an int value, and will not want to be aware that the value is stored as a BitField (and so shifted left so many bits)
 public int getValue(int holder) 
    Obtain the value for the specified BitField, appropriately shifted right. Many users of a BitField will want to treat the specified bits as an int value, and will not want to be aware that the value is stored as a BitField (and so shifted left so many bits)
 public boolean isAllSet(int holder) 
    Are all of the bits set or not? This is a stricter test than isSet, in that all of the bits in a multi-bit set must be set for this method to return true
 public boolean isSet(int holder) 
    Is the field set or not? This is most commonly used for a single-bit field, which is often used to represent a boolean value; the results of using it for a multi-bit field is to determine whether *any* of its bits are set
 public int set(int holder) 
    Set the bits.
 public int setBoolean(int holder,
    boolean flag) 
    Set a boolean BitField
 public byte setByte(byte holder) 
    Set the bits.
 public byte setByteBoolean(byte holder,
    boolean flag) 
    Set a boolean BitField
 public short setShort(short holder) 
    Set the bits.
 public short setShortBoolean(short holder,
    boolean flag) 
    Set a boolean BitField
 public short setShortValue(short holder,
    short value) 
    Replace the bits with new values.
 public int setValue(int holder,
    int value) 
    Replace the bits with new values.