BitList (Apache Brooklyn)

java.lang.Object
- brooklyn.util.math.BitList

```
public class BitList
extends java.lang.Object
```
represents an immutable ordered collection of bits with a known length
when converting to and from bytes and larger numbers, this representation uses the least-significant first convention both for bits and for bytes (little endian)
(i.e. least significant byte is first, as is the least significant bit; ninth element in this list is the least significant bit in the second byte, so a list {0,0,0,0,0,0,0,0,1,0} represents 256)

Method Summary

Methods
Modifier and Type	Method and Description
`BitList`	`anded(BitList other)` represents the result of this bit list logically ANDed with the other
`boolean[]`	`asArray()`
`java.math.BigInteger`	`asBigInteger()`
`java.util.BitSet`	`asBitSet()` nb: BitSet forgets the length
`java.util.List<java.lang.Byte>`	`asByteList()`
`byte[]`	`asBytes()` returns the bits converted to bytes, with least significant bit first and first 8 bits in the first byte
`java.util.List<java.lang.Boolean>`	`asList()`
`int[]`	`asUnsignedBytes()`
`byte`	`byteValue()` returns value of this as a byte(ignoring any too-high bits)
`int`	`commonPrefixLength(BitList other)`
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`get(int index)`
`int`	`hashCode()`
`int`	`intValue()` returns value of this as an integer (ignoring any too-high bits)
`boolean`	`isEmpty()` true iff the length is 0; see also isZero
`boolean`	`isZero()` true iff all bits are 0
`int`	`length()`
`long`	`longValue()` returns value of this as a long (ignoring any too-high bits)
`static BitList`	`newInstance(java.math.BigInteger x)`
`static BitList`	`newInstance(java.util.BitSet bits, int length)`
`static BitList`	`newInstance(boolean... l)`
`static BitList`	`newInstance(byte... bytes)`
`static BitList`	`newInstance(java.util.List<java.lang.Boolean> l)`
`static BitList`	`newInstanceFromBytes(int... bytes)` as `newInstance(byte...)`, but accepting ints for convenience; only the least significant 8 bits of the parameters are considered
`BitList`	`notted()` represents the result of this bit list logically notted
`BitList`	`orred(BitList other)` represents the result of this bit list logically ORred with the other
`BitList`	`resized(int length)` creates a new instance with the given length, either reducing the list or padding it with 0's (at the end, in both cases)
`BitList`	`reversed()`
`java.lang.String`	`toString()`
`BitList`	`xorred(BitList other)` represents the result of this bit list logically XORred with the other

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newInstance
```
public static BitList newInstance(java.util.BitSet bits,
                  int length)
```
  - length
```
public int length()
```
  - get
```
public boolean get(int index)
```
  - newInstance
```
public static BitList newInstance(byte... bytes)
```
  - newInstanceFromBytes
```
public static BitList newInstanceFromBytes(int... bytes)
```
    as newInstance(byte...), but accepting ints for convenience; only the least significant 8 bits of the parameters are considered
  - newInstance
```
public static BitList newInstance(java.util.List<java.lang.Boolean> l)
```
  - newInstance
```
public static BitList newInstance(boolean... l)
```
  - newInstance
```
public static BitList newInstance(java.math.BigInteger x)
```
  - asBytes
```
public byte[] asBytes()
```
    returns the bits converted to bytes, with least significant bit first *and* first 8 bits in the first byte
    NB this may be different to BitSet.valueOf available since java 7 (as late as that!) which reverses the order of the bytes
  - asUnsignedBytes
```
public int[] asUnsignedBytes()
```
  - asBitSet
```
public java.util.BitSet asBitSet()
```
    nb: BitSet forgets the length
  - asList
```
public java.util.List<java.lang.Boolean> asList()
```
  - orred
```
public BitList orred(BitList other)
```
    represents the result of this bit list logically ORred with the other
  - anded
```
public BitList anded(BitList other)
```
    represents the result of this bit list logically ANDed with the other
  - xorred
```
public BitList xorred(BitList other)
```
    represents the result of this bit list logically XORred with the other
  - notted
```
public BitList notted()
```
    represents the result of this bit list logically notted
  - resized
```
public BitList resized(int length)
```
    creates a new instance with the given length, either reducing the list or padding it with 0's (at the end, in both cases)
  - reversed
```
public BitList reversed()
```
  - commonPrefixLength
```
public int commonPrefixLength(BitList other)
```
  - isEmpty
```
public boolean isEmpty()
```
    true iff the length is 0; see also isZero
  - isZero
```
public boolean isZero()
```
    true iff all bits are 0
  - asBigInteger
```
public java.math.BigInteger asBigInteger()
```
  - asArray
```
public boolean[] asArray()
```
  - asByteList
```
public java.util.List<java.lang.Byte> asByteList()
```
  - byteValue
```
public byte byteValue()
```
    returns value of this as a byte(ignoring any too-high bits)
  - intValue
```
public int intValue()
```
    returns value of this as an integer (ignoring any too-high bits)
  - longValue
```
public long longValue()
```
    returns value of this as a long (ignoring any too-high bits)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BitList

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newInstance

length

get

newInstance

newInstanceFromBytes

newInstance

newInstance

newInstance

asBytes

asUnsignedBytes

asBitSet

asList

orred

anded

xorred

notted

resized

reversed

commonPrefixLength

isEmpty

isZero

asBigInteger

asArray

asByteList

byteValue

intValue

longValue

hashCode

equals

toString