Bits (java-util 1.6.0 API)

java.lang.Object
- com.simiacryptus.util.binary.Bits

All Implemented Interfaces:: Comparable<Bits>

public class Bits
extends Object
implements Comparable<Bits>

The type Bits.

Field Summary

Fields
Modifier and Type Field and Description

int bitLength
The Bit length.

static Bits NULL
The constant NULL.

static Bits ONE
The constant ONE.

static Bits ZERO
The constant ZERO.

Fields
Modifier and Type	Field and Description
`int`	`bitLength` The Bit length.
`static Bits`	`NULL` The constant NULL.
`static Bits`	`ONE` The constant ONE.
`static Bits`	`ZERO` The constant ZERO.

Constructor Summary

Constructors
Constructor and Description
`Bits(byte... data)` Instantiates a new Bits.
`Bits(byte[] data, int length)` Instantiates a new Bits.
`Bits(long data)` Instantiates a new Bits.
`Bits(long value, int length)` Instantiates a new Bits.
`Bits(Random random, int length)` Instantiates a new Bits.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bits`	`bitwiseAnd(Bits right)` Bitwise and bits.
`Bits`	`bitwiseOr(Bits right)` Bitwise or bits.
`Bits`	`bitwiseXor(Bits right)` Bitwise xor bits.
`int`	`compareTo(Bits arg0)`
`Bits`	`concatenate(Bits right)` Concatenate bits.
`static int`	`dataCompare(Bits left, Bits right)` Data compare int.
`static Bits`	`divide(long numerator, long denominator, long maxBits)` Divide bits.
`boolean`	`equals(Object obj)`
`byte[]`	`getBytes()` Get bytes byte [ ].
`int`	`hashCode()`
`static byte`	`highestOneBit(long v)` Highest one bit byte.
`Bits`	`leftShift(int bits)` Left shift bits.
`Bits`	`next()` Returns the next binary string which is of the same length but incremented by one.
`Bits`	`padLeft(int targetLength)` Pad left bits.
`static byte[]`	`padLeftBytes(byte[] src, int bytes)` Pad left bytes byte [ ].
`Bits`	`padRight(long targetLength)` Pad right bits.
`Bits`	`range(int start)` Range bits.
`Bits`	`range(int start, int length)` Range bits.
`static byte[]`	`shiftLeft(byte[] src, int bits)` Shift left byte [ ].
`static void`	`shiftLeft(byte[] src, int bits, byte[] dst)` Shift left.
`static byte[]`	`shiftRight(byte[] src, int bits)` Shift right byte [ ].
`boolean`	`startsWith(Bits key)` Starts apply boolean.
`CharSequence`	`toBase64String()` To base 64 string string.
`String`	`toBitString()` To bit string string.
`static byte[]`	`toBytes(long data)` To bytes byte [ ].
`CharSequence`	`toHexString()` To hex string string.
`long`	`toLong()` To long long.
`String`	`toString()`
`static byte[]`	`trim(byte[] bytes)` Trim byte [ ].

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

- Field Detail
  - ONE
```
public static Bits ONE
```
    The constant ONE.
  - ZERO
```
public static Bits ZERO
```
    The constant ZERO.
  - NULL
```
public static Bits NULL
```
    The constant NULL.
  - bitLength
```
public final int bitLength
```
    The Bit length.
- Constructor Detail
  - Bits
```
public Bits(byte... data)
```
    Instantiates a new Bits.
    
    Parameters:
    
    data - the data
  - Bits
```
public Bits(byte[] data,
            int length)
```
    Instantiates a new Bits.
    
    Parameters:
    
    data - the data
    
    length - the length
  - Bits
```
public Bits(long data)
```
    Instantiates a new Bits.
    
    Parameters:
    
    data - the data
  - Bits
```
public Bits(long value,
            int length)
```
    Instantiates a new Bits.
    
    Parameters:
    
    value - the value
    
    length - the length
  - Bits
```
public Bits(Random random,
            int length)
```
    Instantiates a new Bits.
    
    Parameters:
    
    random - the random
    
    length - the length
- Method Detail
  - divide
```
public static Bits divide(long numerator,
                          long denominator,
                          long maxBits)
```
    Divide bits.
    
    Parameters:
    
    numerator - the numerator
    
    denominator - the denominator
    
    maxBits - the max bits
    
    Returns:
    
    the bits
  - dataCompare
```
public static int dataCompare(Bits left,
                              Bits right)
```
    Data compare int.
    
    Parameters:
    
    left - the left
    
    right - the right
    
    Returns:
    
    the int
  - highestOneBit
```
public static byte highestOneBit(long v)
```
    Highest one bit byte.
    
    Parameters:
    
    v - the v
    
    Returns:
    
    the byte
  - padLeftBytes
```
public static byte[] padLeftBytes(byte[] src,
                                  int bytes)
```
    Pad left bytes byte [ ].
    
    Parameters:
    
    src - the src
    
    bytes - the bytes
    
    Returns:
    
    the byte [ ]
  - shiftLeft
```
public static byte[] shiftLeft(byte[] src,
                               int bits)
```
    Shift left byte [ ].
    
    Parameters:
    
    src - the src
    
    bits - the bits
    
    Returns:
    
    the byte [ ]
  - shiftLeft
```
public static void shiftLeft(byte[] src,
                             int bits,
                             byte[] dst)
```
    Shift left.
    
    Parameters:
    
    src - the src
    
    bits - the bits
    
    dst - the dst
  - shiftRight
```
public static byte[] shiftRight(byte[] src,
                                int bits)
```
    Shift right byte [ ].
    
    Parameters:
    
    src - the src
    
    bits - the bits
    
    Returns:
    
    the byte [ ]
  - toBytes
```
public static byte[] toBytes(long data)
```
    To bytes byte [ ].
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the byte [ ]
  - trim
```
public static byte[] trim(byte[] bytes)
```
    Trim byte [ ].
    
    Parameters:
    
    bytes - the bytes
    
    Returns:
    
    the byte [ ]
  - bitwiseAnd
```
public Bits bitwiseAnd(Bits right)
```
    Bitwise and bits.
    
    Parameters:
    
    right - the right
    
    Returns:
    
    the bits
  - bitwiseOr
```
public Bits bitwiseOr(Bits right)
```
    Bitwise or bits.
    
    Parameters:
    
    right - the right
    
    Returns:
    
    the bits
  - bitwiseXor
```
public Bits bitwiseXor(Bits right)
```
    Bitwise xor bits.
    
    Parameters:
    
    right - the right
    
    Returns:
    
    the bits
  - compareTo
```
public int compareTo(Bits arg0)
```
    Specified by:
    
    compareTo in interface Comparable<Bits>
  - concatenate
```
public Bits concatenate(Bits right)
```
    Concatenate bits.
    
    Parameters:
    
    right - the right
    
    Returns:
    
    the bits
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getBytes
```
public byte[] getBytes()
```
    Get bytes byte [ ].
    
    Returns:
    
    the byte [ ]
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - leftShift
```
public Bits leftShift(int bits)
```
    Left shift bits.
    
    Parameters:
    
    bits - the bits
    
    Returns:
    
    the bits
  - next
```
public Bits next()
```
    Returns the next binary string which is of the same length but incremented by one. Returns null on overflow
    
    Returns:
    
    bits bits
  - range
```
public Bits range(int start)
```
    Range bits.
    
    Parameters:
    
    start - the start
    
    Returns:
    
    the bits
  - range
```
public Bits range(int start,
                  int length)
```
    Range bits.
    
    Parameters:
    
    start - the start
    
    length - the length
    
    Returns:
    
    the bits
  - startsWith
```
public boolean startsWith(Bits key)
```
    Starts apply boolean.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the boolean
  - toBitString
```
public String toBitString()
```
    To bit string string.
    
    Returns:
    
    the string
  - toHexString
```
public CharSequence toHexString()
```
    To hex string string.
    
    Returns:
    
    the string
  - toBase64String
```
public CharSequence toBase64String()
```
    To base 64 string string.
    
    Returns:
    
    the string
  - toLong
```
public long toLong()
```
    To long long.
    
    Returns:
    
    the long
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - padRight
```
public Bits padRight(long targetLength)
```
    Pad right bits.
    
    Parameters:
    
    targetLength - the peek bits
    
    Returns:
    
    the bits
  - padLeft
```
public Bits padLeft(int targetLength)
```
    Pad left bits.
    
    Parameters:
    
    targetLength - the target length
    
    Returns:
    
    the bits

Class Bits

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONE

ZERO

NULL

bitLength

Constructor Detail

Bits

Bits

Bits

Bits

Bits

Method Detail

divide

dataCompare

highestOneBit

padLeftBytes

shiftLeft

shiftLeft

shiftRight

toBytes

trim

bitwiseAnd

bitwiseOr

bitwiseXor

compareTo

concatenate

equals

getBytes

hashCode

leftShift

next

range

range

startsWith

toBitString

toHexString

toBase64String

toLong

toString

padRight

padLeft