Skip navigation links


com.essbase.eas.essbase.api.core
Class BitField

java.lang.Object
  extended by com.essbase.eas.essbase.api.core.BitField

Direct Known Subclasses:
AccessBitField

public class BitField
extends java.lang.Object

This class represents an Essbase API bit field. Bit fields are returned and used by many of the APIs.

Version:
1.00, 06/18/2000
Author:
Hank Cox

Constructor Summary
BitField()
          no argument constructor
BitField(long value)
          constructor with initializer

 

Method Summary
 void clearBits(long value)
          clears specific bits in this field.
 long getValue()
          returns the current value of the bit settings for this field.
 void setBits(long value)
          sets specific bits in this field.
 void setValue(long value)
          sets the bits in this bit field.
 boolean testAllBits(long value)
          returns true if all the bits in the requested value are on.
 boolean testAnyBits(long value)
          returns true if any of the bits in the requested value are on.
 int toInteger()
          converts this bit field from a long to an integer.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

BitField

public BitField()
no argument constructor

BitField

public BitField(long value)
constructor with initializer

Method Detail

getValue

public long getValue()
returns the current value of the bit settings for this field.

setValue

public void setValue(long value)
sets the bits in this bit field.

clearBits

public void clearBits(long value)
clears specific bits in this field.

setBits

public void setBits(long value)
sets specific bits in this field.

testAllBits

public boolean testAllBits(long value)
returns true if all the bits in the requested value are on.

testAnyBits

public boolean testAnyBits(long value)
returns true if any of the bits in the requested value are on.

toInteger

public int toInteger()
converts this bit field from a long to an integer. Mainly used by the JNI-enabling methods.

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.